add swagger docu for `fixed_width_lbl` and `fixed_width_val` (#7764)
* add swagger docu for `fixed_width_lbl` and `fxed_width_val`
Timo committed
Jan 20, 2020 at 11:30 UTC
6ba71e1704ef9fcd9335e1e4e1ad844b00a082fd
2 files changed
+38
web/api/netdata-swagger.json
+22
@@ -522,6 +522,28 @@
522
"type": "number",
523
"format": "integer"
524
}
525
+ },
526
+ {
527
+ "name": "fixed_width_lbl",
528
+ "in": "query",
529
+ "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`.",
530
+ "required": false,
531
+ "allowEmptyValue": false,
532
+ "schema": {
533
+ "type": "number",
534
+ "format": "integer"
535
+ }
536
+ },
537
+ {
538
+ "name": "fixed_width_val",
539
+ "in": "query",
540
+ "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`.",
541
+ "required": false,
542
+ "allowEmptyValue": false,
543
+ "schema": {
544
+ "type": "number",
545
+ "format": "integer"
546
+ }
547
}
548
],
549
"responses": {
web/api/netdata-swagger.yaml
+16
@@ -453,6 +453,22 @@ paths:
453
schema:
454
type: number
455
format: integer
456
+ - name: fixed_width_lbl
457
+ in: query
458
+ 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`.
459
+ required: false
460
+ allowEmptyValue: false
461
+ schema:
462
+ type: number
463
+ format: integer
464
+ - name: fixed_width_val
465
+ in: query
466
+ 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`.
467
+ required: false
468
+ allowEmptyValue: false
469
+ schema:
470
+ type: number
471
+ format: integer
472
responses:
473
"200":
474
description: The call was successful. The response should be an SVG image.