Fix dashboard query swagger definition to reflect reality (#14370)
parent
a73d9a2b77
commit
6e77b64da9
101
http/swagger.yml
101
http/swagger.yml
|
@ -6816,88 +6816,55 @@ components:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/Field'
|
$ref: '#/components/schemas/Field'
|
||||||
QueryConfig:
|
BuilderConfig:
|
||||||
type: object
|
|
||||||
required:
|
|
||||||
- database
|
|
||||||
- measurement
|
|
||||||
- retentionPolicy
|
|
||||||
- areTagsAccepted
|
|
||||||
- tags
|
|
||||||
- groupBy
|
|
||||||
- fields
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: string
|
|
||||||
database:
|
|
||||||
type: string
|
|
||||||
measurement:
|
|
||||||
type: string
|
|
||||||
retentionPolicy:
|
|
||||||
type: string
|
|
||||||
areTagsAccepted:
|
|
||||||
type: boolean
|
|
||||||
rawText:
|
|
||||||
type: string
|
|
||||||
tags:
|
|
||||||
type: object
|
|
||||||
groupBy:
|
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
time:
|
buckets:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
type: string
|
type: string
|
||||||
tags:
|
tags:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
$ref: '#/components/schemas/BuilderTagsType'
|
||||||
required:
|
functions:
|
||||||
- time
|
|
||||||
- tags
|
|
||||||
fields:
|
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/Field'
|
$ref: '#/components/schemas/BuilderFunctionsType'
|
||||||
range:
|
aggregateWindow:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
lower:
|
name:
|
||||||
type: string
|
type: string
|
||||||
upper:
|
BuilderTagsType:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
key:
|
||||||
|
type: string
|
||||||
|
values:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
BuilderFunctionsType:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
name:
|
||||||
type: string
|
type: string
|
||||||
required:
|
|
||||||
- lower
|
|
||||||
- upper
|
|
||||||
DashboardQuery:
|
DashboardQuery:
|
||||||
type: object
|
type: object
|
||||||
required:
|
|
||||||
- query
|
|
||||||
properties:
|
properties:
|
||||||
label:
|
text:
|
||||||
type: string
|
type: string
|
||||||
description: Optional Y-axis user-facing label
|
description: The text of the flux query
|
||||||
range:
|
editMode:
|
||||||
description: Optional default range of the Y-axis
|
$ref: '#/components/schemas/QueryEditMode'
|
||||||
type: object
|
name:
|
||||||
required:
|
|
||||||
- upper
|
|
||||||
- lower
|
|
||||||
properties:
|
|
||||||
upper:
|
|
||||||
description: Upper bound of the display range of the Y-axis
|
|
||||||
type: integer
|
|
||||||
format: int64
|
|
||||||
lower:
|
|
||||||
description: Lower bound of the display range of the Y-axis
|
|
||||||
type: integer
|
|
||||||
format: int64
|
|
||||||
query:
|
|
||||||
type: string
|
type: string
|
||||||
source:
|
builderConfig:
|
||||||
|
$ref: '#/components/schemas/BuilderConfig'
|
||||||
|
QueryEditMode:
|
||||||
type: string
|
type: string
|
||||||
format: uri
|
enum: ['builder', 'advanced']
|
||||||
description: Optional URI for data source for this query
|
|
||||||
queryConfig:
|
|
||||||
$ref: '#/components/schemas/QueryConfig'
|
|
||||||
Axis:
|
Axis:
|
||||||
type: object
|
type: object
|
||||||
description: A description of a particular axis for a visualization
|
description: A description of a particular axis for a visualization
|
||||||
|
@ -6925,8 +6892,11 @@ components:
|
||||||
description: Base represents the radix for formatting axis values.
|
description: Base represents the radix for formatting axis values.
|
||||||
type: string
|
type: string
|
||||||
scale:
|
scale:
|
||||||
|
$ref: '#/components/schemas/AxisScaleType'
|
||||||
|
AxisScaleType:
|
||||||
description: 'Scale is the axis formatting scale. Supported: "log", "linear"'
|
description: 'Scale is the axis formatting scale. Supported: "log", "linear"'
|
||||||
type: string
|
type: string
|
||||||
|
enum: ['log', 'linear']
|
||||||
DashboardColor:
|
DashboardColor:
|
||||||
type: object
|
type: object
|
||||||
description: Color defines an encoding of data value into color space
|
description: Color defines an encoding of data value into color space
|
||||||
|
@ -6951,7 +6921,8 @@ components:
|
||||||
type: string
|
type: string
|
||||||
value:
|
value:
|
||||||
description: Value is the data value mapped to this color
|
description: Value is the data value mapped to this color
|
||||||
type: string
|
type: number
|
||||||
|
format: float
|
||||||
RenamableField:
|
RenamableField:
|
||||||
description: Describes a field that can be renamed and made visible or invisible
|
description: Describes a field that can be renamed and made visible or invisible
|
||||||
type: object
|
type: object
|
||||||
|
|
Loading…
Reference in New Issue