From ff7d13a10a53e70ddfb40631839296fc94fb41d5 Mon Sep 17 00:00:00 2001
From: "Jonathan A. Sternberg" <jonathan@influxdata.com>
Date: Wed, 18 Sep 2019 18:31:12 -0500
Subject: [PATCH] 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.
---
 http/swagger.yml | 52 +++---------------------------------------------
 1 file changed, 3 insertions(+), 49 deletions(-)

diff --git a/http/swagger.yml b/http/swagger.yml
index c26a8a4a1ec..8fbefccb0ad 100644
--- a/http/swagger.yml
+++ b/http/swagger.yml
@@ -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:
-                schema:
-                  type: string
-                  example: >
-                    error,reference
-                    Failed to parse query,897
-              application/vnd.influx.arrow:
+              application/json:
                 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: