Преглед изворни кода

`resolution` documented

Signed-off-by: Matt Ray <github@mattray.dev>
Matt Ray пре 3 година
родитељ
комит
dc7c4ed903
1 измењених фајлова са 22 додато и 0 уклоњено
  1. 22 0
      docs/swagger.json

+ 22 - 0
docs/swagger.json

@@ -111,6 +111,28 @@
             },
             },
           }
           }
         },
         },
+          {
+          "name": "resolution",
+          "in": "query",
+          "description": "Duration to use as resolution in Prometheus queries. Smaller values (i.e. higher resolutions) will provide better accuracy, but worse performance (i.e. slower query time, higher memory use). Larger values (i.e. lower resolutions) will perform better, but at the expense of lower accuracy for short-running workloads. Default is `1m`",
+          "required": false,
+          "style": "form",
+          "explode": true,
+          "schema": {
+            "type": "string"
+          },
+          "examples": {
+            "1m": {
+              "summary": "Highly accurate, slower query.",
+              "value": "1m"
+            },
+            "30m": {
+              "summary": "Less accurate, faster query. Not recommended for short-lived workloads ",
+              "value": "30m"
+            },
+          }
+        },
+
         ],
         ],
         "responses": {
         "responses": {
           "200": {
           "200": {