Docs/5625 v1 get query endpoint

api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml

@@ -66,7 +66,7 @@ paths:
           schema:
             type: string
           required: true
-          description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy.
+          description: Database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy.
         - in: query
           name: rp
           schema:
@@ -137,6 +137,141 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
   /query:
+    get:
+      operationId: GetQueryV1
+      tags:
+        - Query
+      summary: Query using the InfluxDB v1 HTTP API
+      parameters:
+        - $ref: '#/components/parameters/TraceSpan'
+        - $ref: '#/components/parameters/AuthUserV1'
+        - $ref: '#/components/parameters/AuthPassV1'
+        - in: header
+          name: Accept
+          schema:
+            type: string
+            description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps.
+            default: application/json
+            enum:
+              - application/json
+              - application/csv
+              - text/csv
+              - application/x-msgpack
+        - in: header
+          name: Accept-Encoding
+          description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.
+          schema:
+            type: string
+            description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity.
+            default: identity
+            enum:
+              - gzip
+              - identity
+        - in: query
+          name: chunked
+          description: |
+            If true, the response is divided into chunks of size `chunk_size`.
+          schema:
+            type: boolean
+            default: false
+        - in: query
+          name: chunk_size
+          description: |
+            The number of records that will go into a chunk.
+            This parameter is only used if `chunked=true`.
+          schema:
+            type: integer
+            default: 10000
+        - in: query
+          name: db
+          schema:
+            type: string
+          required: true
+          description: The database to query from.
+        - in: query
+          name: pretty
+          description: |
+            If true, the JSON response is formatted in a human-readable format.
+          schema:
+            type: boolean
+            default: false
+        - in: query
+          name: q
+          description: Defines the InfluxQL query to run.
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: rp
+          schema:
+            type: string
+          description: Retention policy name.
+        - name: epoch
+          description: |
+            Formats timestamps as unix (epoch) timestamps with the specified precision
+            instead of RFC3339 timestamps with nanosecond precision.
+          in: query
+          schema:
+            type: string
+            enum:
+              - h
+              - m
+              - s
+              - ms
+              - u
+              - µ
+              - ns
+      responses:
+        '200':
+          description: Query results
+          headers:
+            Content-Encoding:
+              description: The Content-Encoding entity header is used to compress the media-type.  When present, its value indicates which encodings were applied to the entity-body
+              schema:
+                type: string
+                description: Specifies that the response in the body is encoded with gzip or not encoded with identity.
+                default: identity
+                enum:
+                  - gzip
+                  - identity
+            Trace-Id:
+              description: The Trace-Id header reports the request's trace ID, if one was generated.
+              schema:
+                type: string
+                description: Specifies the request's trace ID.
+          content:
+            application/csv:
+              schema:
+                $ref: '#/components/schemas/InfluxQLCSVResponse'
+            text/csv:
+              schema:
+                $ref: '#/components/schemas/InfluxQLCSVResponse'
+            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
+                format: binary
+        '429':
+          description: Token is temporarily over quota. The Retry-After header describes when to try the read again.
+          headers:
+            Retry-After:
+              description: A non-negative decimal integer indicating the seconds to delay after the response is received.
+              schema:
+                type: integer
+                format: int32
+        default:
+          description: Error processing query
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
     post:
       operationId: PostQueryV1
       tags:
@@ -148,6 +283,42 @@ paths:
           text/plain:
             schema:
               type: string
+          application/json:
+            schema:
+              type: object
+              properties:
+                db:
+                  type: string
+                  description: The database to query from.
+                rp:
+                  description: |
+                    The retention policy to query data from. For more information, see [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention).
+                  type: string
+                q:
+                  description: Defines the InfluxQL query to run.
+                  type: string
+                chunked:
+                  description: |
+                    If true, the response is divided into chunks of size `chunk_size`.
+                  type: boolean
+                chunk_size:
+                  description: |
+                    The number of records that will go into a chunk.
+                    This parameter is only used if `chunked=true`.
+                  type: integer
+                  default: 10000
+                epoch:
+                  description: |
+                    A unix timestamp precision.
+                  type: string
+                  enum:
+                    - h
+                    - m
+                    - s
+                    - ms
+                    - u
+                    - µ
+                    - ns
       parameters:
         - $ref: '#/components/parameters/TraceSpan'
         - $ref: '#/components/parameters/AuthUserV1'
@@ -184,7 +355,7 @@ paths:
           schema:
             type: string
           required: true
-          description: Bucket to query.
+          description: Database to query.
         - in: query
           name: rp
           schema:

api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml

@@ -65,7 +65,7 @@ paths:
           schema:
             type: string
           required: true
-          description: Bucket to write to. If none exists, InfluxDB creates a bucket with a default 3-day retention policy.
+          description: Database to write to. If none exists, InfluxDB creates a database with a default 3-day retention policy.
         - in: query
           name: rp
           schema:
@@ -136,6 +136,141 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
   /query:
+    get:
+      operationId: GetQueryV1
+      tags:
+        - Query
+      summary: Query using the InfluxDB v1 HTTP API
+      parameters:
+        - $ref: '#/components/parameters/TraceSpan'
+        - $ref: '#/components/parameters/AuthUserV1'
+        - $ref: '#/components/parameters/AuthPassV1'
+        - in: header
+          name: Accept
+          schema:
+            type: string
+            description: Specifies how query results should be encoded in the response. **Note:** With `application/csv`, query results include epoch timestamps instead of RFC3339 timestamps.
+            default: application/json
+            enum:
+              - application/json
+              - application/csv
+              - text/csv
+              - application/x-msgpack
+        - in: header
+          name: Accept-Encoding
+          description: The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.
+          schema:
+            type: string
+            description: Specifies that the query response in the body should be encoded with gzip or not encoded with identity.
+            default: identity
+            enum:
+              - gzip
+              - identity
+        - in: query
+          name: chunked
+          description: |
+            If true, the response is divided into chunks of size `chunk_size`.
+          schema:
+            type: boolean
+            default: false
+        - in: query
+          name: chunk_size
+          description: |
+            The number of records that will go into a chunk.
+            This parameter is only used if `chunked=true`.
+          schema:
+            type: integer
+            default: 10000
+        - in: query
+          name: db
+          schema:
+            type: string
+          required: true
+          description: The database to query from.
+        - in: query
+          name: pretty
+          description: |
+            If true, the JSON response is formatted in a human-readable format.
+          schema:
+            type: boolean
+            default: false
+        - in: query
+          name: q
+          description: Defines the InfluxQL query to run.
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: rp
+          schema:
+            type: string
+          description: Retention policy name.
+        - name: epoch
+          description: |
+            Formats timestamps as unix (epoch) timestamps with the specified precision
+            instead of RFC3339 timestamps with nanosecond precision.
+          in: query
+          schema:
+            type: string
+            enum:
+              - h
+              - m
+              - s
+              - ms
+              - u
+              - µ
+              - ns
+      responses:
+        '200':
+          description: Query results
+          headers:
+            Content-Encoding:
+              description: The Content-Encoding entity header is used to compress the media-type.  When present, its value indicates which encodings were applied to the entity-body
+              schema:
+                type: string
+                description: Specifies that the response in the body is encoded with gzip or not encoded with identity.
+                default: identity
+                enum:
+                  - gzip
+                  - identity
+            Trace-Id:
+              description: The Trace-Id header reports the request's trace ID, if one was generated.
+              schema:
+                type: string
+                description: Specifies the request's trace ID.
+          content:
+            application/csv:
+              schema:
+                $ref: '#/components/schemas/InfluxQLCSVResponse'
+            text/csv:
+              schema:
+                $ref: '#/components/schemas/InfluxQLCSVResponse'
+            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
+                format: binary
+        '429':
+          description: Token is temporarily over quota. The Retry-After header describes when to try the read again.
+          headers:
+            Retry-After:
+              description: A non-negative decimal integer indicating the seconds to delay after the response is received.
+              schema:
+                type: integer
+                format: int32
+        default:
+          description: Error processing query
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
     post:
       operationId: PostQueryV1
       tags:
@@ -147,6 +282,42 @@ paths:
           text/plain:
             schema:
               type: string
+          application/json:
+            schema:
+              type: object
+              properties:
+                db:
+                  type: string
+                  description: Database to query.
+                rp:
+                  description: |
+                    The retention policy to query data from. 
+                  type: string
+                q:
+                  description: Defines the InfluxQL query to run.
+                  type: string
+                chunked:
+                  description: |
+                    If true, the response is divided into chunks of size `chunk_size`.
+                  type: boolean
+                chunk_size:
+                  description: |
+                    The number of records that will go into a chunk.
+                    This parameter is only used if `chunked=true`.
+                  type: integer
+                  default: 10000
+                epoch:
+                  description: |
+                    A unix timestamp precision.
+                  type: string
+                  enum:
+                    - h
+                    - m
+                    - s
+                    - ms
+                    - u
+                    - µ
+                    - ns
       parameters:
         - $ref: '#/components/parameters/TraceSpan'
         - $ref: '#/components/parameters/AuthUserV1'