Parcourir la source

Added `step` to /allocation/compute

Signed-off-by: Matt Ray <github@mattray.dev>
Matt Ray il y a 3 ans
Parent
commit
5f96717d1c
1 fichiers modifiés avec 26 ajouts et 1 suppressions
  1. 26 1
      docs/swagger.json

+ 26 - 1
docs/swagger.json

@@ -110,6 +110,31 @@
               "value": "container"
             },
           }
+        },
+          {
+          "name": "step",
+          "in": "query",
+          "description": "Duration of a single allocation set. If unspecified, this defaults to the window, so that you receive exactly one set for the entire window. If specified, it works chronologically backward, querying in durations of step until the full window is covered. Default is `window`",
+          "required": false,
+          "style": "form",
+          "explode": true,
+          "schema": {
+            "type": "string"
+          },
+          "examples": {
+            "30m": {
+              "summary": "30 minute steps over the duration of the window.",
+              "value": "30m"
+            },
+            "2h": {
+              "summary": "2 hour steps over the duration of the window",
+              "value": "2h"
+            },
+            "1d": {
+              "summary": "Daily steps over the duration of the window (ie. `lastweek` or `month`",
+              "value": "1d"
+            },
+          }
         },
           {
           "name": "resolution",
@@ -127,7 +152,7 @@
               "value": "1m"
             },
             "30m": {
-              "summary": "Less accurate, faster query. Not recommended for short-lived workloads ",
+              "summary": "Less accurate, faster query. Not recommended for short-lived workloads.",
               "value": "30m"
             },
           }