Skip to content

Commit

Permalink
Merge pull request #5473 from influxdata/jstirnaman/issue5463
Browse files Browse the repository at this point in the history 
fix: add missing partial and schema descriptions for InfluxQL JSON response
  • Loading branch information
@jstirnaman
jstirnaman authored May 17, 2024
2 parents 64b2023 + 9a8ae35 commit d3d2c83
Show file tree
Hide file tree
Showing 10 changed files with 495 additions and 120 deletions.
81 changes: 58 additions & 23 deletions api-docs/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ paths:
operationId: PostQueryV1
tags:
- Query
summary: Query InfluxDB in a V1 compatible format
summary: Query using the InfluxDB v1 HTTP API
requestBody:
description: InfluxQL query to execute.
content:
Expand Down Expand Up @@ -217,6 +217,11 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/InfluxQLResponse'
examples:
influxql-chunk_size_2:
value: |
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:55Z",90,"1"],["2016-05-19T18:37:56Z",90,"1"]],"partial":true}],"partial":true}]}
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:57Z",90,"1"],["2016-05-19T18:37:58Z",90,"1"]]}]}]}
application/x-msgpack:
schema:
type: string
Expand Down Expand Up @@ -265,45 +270,75 @@ components:
description: User token.
schemas:
InfluxQLResponse:
description: |
The JSON response for an InfluxQL query.
A response contains the collection of results for a query.
`results` is an array of resultset objects.
If the response is chunked, the `transfer-encoding` response header is set to `chunked` and each resultset object is sent in a separate JSON object.
properties:
results:
type: array
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
description: |
A resultset object that contains the `statement_id` and the `series` array.
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
items:
type: object
properties:
statement_id:
type: integer
error:
type: string
partial:
description: |
True if the resultset is not complete--the response data is chunked; otherwise, false or omitted.
type: boolean
series:
type: array
description: |
An array of series objects--the results of the query. A series of rows shares the same group key returned from the execution of a statement.
If a property is not present, it is assumed to be `null`.
items:
type: object
properties:
columns:
description: An array of column names
items:
type: string
type: array
name:
description: The name of the series
type: string
tags:
type: object
additionalProperties:
type: string
partial:
description: |
True if the series is not complete--the response data is chunked; otherwise, false or omitted.
type: boolean
columns:
type: array
items:
tags:
additionalProperties:
type: string
description: |
A map of tag key-value pairs. If a tag key is not present, it is assumed to be `null`.
type: object
values:
type: array
description: |
An array of rows, where each row is an array of values.
items:
type: array
items: {}
type: array
type: array
type: object
type: array
statement_id:
description: |
An integer that represents the statement's position in the query. If statement results are buffered in memory, `statement_id` is used to combine statement results.
type: integer
type: object
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
type: array
type: object
InfluxQLCSVResponse:
type: string
example: |
Expand Down
42 changes: 41 additions & 1 deletion api-docs/cloud-dedicated/v2/ref.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,11 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/InfluxqlJsonResponse'
examples:
influxql-chunk_size_2:
value: |
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:55Z",90,"1"],["2016-05-19T18:37:56Z",90,"1"]],"partial":true}],"partial":true}]}
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:57Z",90,"1"],["2016-05-19T18:37:58Z",90,"1"]]}]}]}
application/x-msgpack:
schema:
format: binary
Expand Down Expand Up @@ -1220,38 +1225,73 @@ components:
name,tags,time,test_field,test_tag test_measurement,,1603740794286107366,1,tag_value test_measurement,,1603740870053205649,2,tag_value test_measurement,,1603741221085428881,3,tag_value
type: string
InfluxqlJsonResponse:
description: JSON Response to InfluxQL Query
description: |
The JSON response for an InfluxQL query.
A response contains the collection of results for a query.
`results` is an array of resultset objects.
If the response is chunked, the `transfer-encoding` response header is set to `chunked` and each resultset object is sent in a separate JSON object.
properties:
results:
description: |
A resultset object that contains the `statement_id` and the `series` array.
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
items:
properties:
error:
type: string
partial:
description: |
True if the resultset is not complete--the response data is chunked; otherwise, false or omitted.
type: boolean
series:
description: |
An array of series objects--the results of the query. A series of rows shares the same group key returned from the execution of a statement.
If a property is not present, it is assumed to be `null`.
items:
properties:
columns:
description: An array of column names
items:
type: string
type: array
name:
description: The name of the series
type: string
partial:
description: |
True if the series is not complete--the response data is chunked; otherwise, false or omitted.
type: boolean
tags:
additionalProperties:
type: string
description: |
A map of tag key-value pairs. If a tag key is not present, it is assumed to be `null`.
type: object
values:
description: |
An array of rows, where each row is an array of values.
items:
items: {}
type: array
type: array
type: object
type: array
statement_id:
description: |
An integer that represents the statement's position in the query. If statement results are buffered in memory, `statement_id` is used to combine statement results.
type: integer
type: object
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
type: array
type: object
IntegerLiteral:
Expand Down
81 changes: 58 additions & 23 deletions api-docs/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ paths:
operationId: PostQueryV1
tags:
- Query
summary: Query InfluxDB in a V1 compatible format
summary: Query using the InfluxDB v1 HTTP API
requestBody:
description: InfluxQL query to execute.
content:
Expand Down Expand Up @@ -217,6 +217,11 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/InfluxQLResponse'
examples:
influxql-chunk_size_2:
value: |
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:55Z",90,"1"],["2016-05-19T18:37:56Z",90,"1"]],"partial":true}],"partial":true}]}
{"results":[{"statement_id":0,"series":[{"name":"mymeas","columns":["time","myfield","mytag"],"values":[["2016-05-19T18:37:57Z",90,"1"],["2016-05-19T18:37:58Z",90,"1"]]}]}]}
application/x-msgpack:
schema:
type: string
Expand Down Expand Up @@ -265,45 +270,75 @@ components:
description: User token.
schemas:
InfluxQLResponse:
description: |
The JSON response for an InfluxQL query.
A response contains the collection of results for a query.
`results` is an array of resultset objects.
If the response is chunked, the `transfer-encoding` response header is set to `chunked` and each resultset object is sent in a separate JSON object.
properties:
results:
type: array
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
description: |
A resultset object that contains the `statement_id` and the `series` array.
Except for `statement_id`, all properties are optional and omitted if empty. If a property is not present, it is assumed to be `null`.
items:
type: object
properties:
statement_id:
type: integer
error:
type: string
partial:
description: |
True if the resultset is not complete--the response data is chunked; otherwise, false or omitted.
type: boolean
series:
type: array
description: |
An array of series objects--the results of the query. A series of rows shares the same group key returned from the execution of a statement.
If a property is not present, it is assumed to be `null`.
items:
type: object
properties:
columns:
description: An array of column names
items:
type: string
type: array
name:
description: The name of the series
type: string
tags:
type: object
additionalProperties:
type: string
partial:
description: |
True if the series is not complete--the response data is chunked; otherwise, false or omitted.
type: boolean
columns:
type: array
items:
tags:
additionalProperties:
type: string
description: |
A map of tag key-value pairs. If a tag key is not present, it is assumed to be `null`.
type: object
values:
type: array
description: |
An array of rows, where each row is an array of values.
items:
type: array
items: {}
type: array
type: array
type: object
type: array
statement_id:
description: |
An integer that represents the statement's position in the query. If statement results are buffered in memory, `statement_id` is used to combine statement results.
type: integer
type: object
oneOf:
- required:
- statement_id
- error
- required:
- statement_id
- series
type: array
type: object
InfluxQLCSVResponse:
type: string
example: |
Expand Down
Loading

0 comments on commit d3d2c83

Please sign in to comment.