From fb1d0fdf84e47480c24661698ce2f0de9428d2ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?An=C5=BEe=20=C5=BDitnik?= <anze.zitnik@xlab.si> Date: Tue, 12 Jul 2022 18:09:43 +0200 Subject: [PATCH] Update README to include info about time parameters format --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a06f038..6581fab 100644 --- a/README.md +++ b/README.md @@ -31,11 +31,15 @@ Run container:`docker run -p 8080:8080 -p 9090:9090 cce` * `/tree/` -- returns the current tree state for the only cloud service present (returns error if handling multiple services) * `/{cloud-service-ID}/` -- returns the current tree state for the specified cloud service -* `/{cloud-service-ID}?time={timestamp}` -- returns the tree state for the specified service valid at the time specified (valid formats are ISO 8601 and "yyyyMMddHHmmss" (UTC timezone)) +* `/{cloud-service-ID}?time={timestamp}` -- returns the tree state for the specified service valid at the time specified * `/{cloud-service-ID}/statistics?start={timestamp}&end={timestamp}` -- returns the statistics for the specified cloud service and the time period between start and end times. End time is optional (defaults to current time). * `/{cloud-service-ID}/listHistory` -- returns a list (tree state ID and timestamp) of all saved tree states for the specified cloud service * `/history/{treeStateId}` -- returns the specific tree state by ID + +> Valid formats for passing time parameters are ISO 8601 (which must include milliseconds) and "yyyyMMddHHmmss" (where UTC timezone is applied). +Example: `2022-07-12T14:50:08.000Z` or `20220712145008` + ### Local usage and development #### Requirements -- GitLab