docs(http): fix the documentation for the query swagger endpoint (#15181)

The `/query` swagger endpoint now specifies that error messages are
returned as the standard JSON schema. The standard JSON schema has also
been changed slightly so that only `code` and `message` are documented
and the intention is that we will flatten the message from an
`influxdb.Error` before we encode the JSON.
pull/15197/head
Jonathan A. Sternberg 2019-09-18 18:31:12 -05:00 committed by GitHub
parent eb15b346cc
commit ff7d13a10a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 49 deletions

View File

@ -3140,28 +3140,6 @@ paths:
schema:
type: string
format: binary
'400':
description: error processing query
headers:
X-Influx-Error:
description: error string describing the problem
schema:
type: string
X-Influx-Reference:
description: reference code unique to the error type
schema:
type: integer
content:
text/csv:
schema:
type: string
example: >
error,reference
Failed to parse query,897
application/vnd.influx.arrow:
schema:
type: string
format: binary
'429':
description: token is temporarily over quota. The Retry-After header describes when to try the read again.
headers:
@ -3171,27 +3149,11 @@ paths:
type: integer
format: int32
default:
description: internal server error
headers:
X-Influx-Error:
description: error string describing the problem
schema:
type: string
X-Influx-Reference:
description: reference code unique to the error type
schema:
type: integer
description: error processing query
content:
text/csv:
application/json:
schema:
type: string
example: >
error,reference
Failed to parse query,897
application/vnd.influx.arrow:
schema:
type: string
format: binary
$ref: "#/components/schemas/Error"
/buckets:
get:
operationId: GetBuckets
@ -7297,14 +7259,6 @@ components:
readOnly: true
description: message is a human-readable message.
type: string
op:
readOnly: true
description: op describes the logical code operation during error. Useful for debugging.
type: string
err:
readOnly: true
description: err is a stack of errors that occurred during processing of the request. Useful for debugging.
type: string
required: [code, message]
LineProtocolError:
properties: