add swagger docu for fixed_width_lbl and fixed_width_val (netdata…

…#7764) * add swagger docu for `fixed_width_lbl` and `fxed_width_val`
MohameedElsaeid · Jan 20, 2020 · 6ba71e1 · 6ba71e1
1 parent 813351b
commit 6ba71e1
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/web/api/netdata-swagger.json b/web/api/netdata-swagger.json
@@ -522,6 +522,28 @@
               "type": "number",
               "format": "integer"
             }
+          },
+          {
+            "name": "fixed_width_lbl",
+            "in": "query",
+            "description": "This parameter overrides auto-sizing of badge and creates it with fixed width. This parameter determines the size of the label's left side *(label/name)*. You must set this parameter together with `fixed_width_val` otherwise it will be ignored. You should set the label/value widths wide enough to provide space for all the possible values/contents of the badge you're requesting. In case the text cannot fit the space given it will be clipped. The `scale` parameter still applies on the values you give to `fixed_width_lbl` and `fixed_width_val`.",
+            "required": false,
+            "allowEmptyValue": false,
+            "schema": {
+              "type": "number",
+              "format": "integer"
+            }
+          },
+          {
+            "name": "fixed_width_val",
+            "in": "query",
+            "description": "This parameter overrides auto-sizing of badge and creates it with fixed width. This parameter determines the size of the label's right side *(value)*. You must set this parameter together with `fixed_width_lbl` otherwise it will be ignored. You should set the label/value widths wide enough to provide space for all the possible values/contents of the badge you're requesting. In case the text cannot fit the space given it will be clipped. The `scale` parameter still applies on the values you give to `fixed_width_lbl` and `fixed_width_val`.",
+            "required": false,
+            "allowEmptyValue": false,
+            "schema": {
+              "type": "number",
+              "format": "integer"
+            }
           }
         ],
         "responses": {

diff --git a/web/api/netdata-swagger.yaml b/web/api/netdata-swagger.yaml
@@ -453,6 +453,22 @@ paths:
           schema:
             type: number
             format: integer
+        - name: fixed_width_lbl
+          in: query
+          description: This parameter overrides auto-sizing of badge and creates it with fixed width. This parameter determines the size of the label's left side *(label/name)*. You must set this parameter together with `fixed_width_val` otherwise it will be ignored. You should set the label/value widths wide enough to provide space for all the possible values/contents of the badge you're requesting. In case the text cannot fit the space given it will be clipped. The `scale` parameter still applies on the values you give to `fixed_width_lbl` and `fixed_width_val`.
+          required: false
+          allowEmptyValue: false
+          schema:
+            type: number
+            format: integer
+        - name: fixed_width_val
+          in: query
+          description: This parameter overrides auto-sizing of badge and creates it with fixed width. This parameter determines the size of the label's right side *(value)*. You must set this parameter together with `fixed_width_lbl` otherwise it will be ignored. You should set the label/value widths wide enough to provide space for all the possible values/contents of the badge you're requesting. In case the text cannot fit the space given it will be clipped. The `scale` parameter still applies on the values you give to `fixed_width_lbl` and `fixed_width_val`.
+          required: false
+          allowEmptyValue: false
+          schema:
+            type: number
+            format: integer
       responses:
         "200":
           description: The call was successful. The response should be an SVG image.