Merge pull request #6274 from influxdata/docs/5625-v1-get-query-endpoint

Docs/5625 v1 get query endpoint

Author: MeelahMe

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

@@ -66,7 +66,22 @@ 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: |
+            The database to write to.
+
+            **Database targeting:** In Cloud Dedicated, databases can be named using the `database_name/retention_policy_name` convention for InfluxQL compatibility. Cloud Dedicated does not use DBRP mappings. The db and rp parameters are used to construct the target database name following this naming convention.
+
+            **Auto-creation behavior:** Cloud Dedicated requires databases to be created before writing data. The v1 `/write` API does not automatically create databases. If the specified
+            database does not exist, the write request will fail.
+
+            Authentication: Requires a valid API token with _write_ permissions for the target database.
+
+            ### Related
+
+            - [Write data to InfluxDB Cloud Dedicated](/influxdb3/cloud-dedicated/write-data/)
+            - [Manage databases in InfluxDB Cloud Dedicated](/influxdb3/cloud-dedicated/admin/databases/)
+            - [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention)
+            - [InfluxQL data retention policy mapping differences](/influxdb3/cloud-serverless/guides/prototype-evaluation/#influxql-data-retention-policy-mapping-differences)
         - in: query
           name: rp
           schema:
@@ -137,6 +152,160 @@ 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: |
+            The retention policy name for InfluxQL compatibility
+
+            Optional parameter that, when combined with the db parameter, forms the complete database name to query. In InfluxDB Cloud Dedicated, databases can be named using the
+            database_name/retention_policy_name convention for InfluxQL compatibility.
+
+            When a request specifies both `db` and `rp`, Cloud Dedicated combines them as `db/rp` to target the database--for example:
+
+            - If `db=mydb` and `rp=autogen`, the query targets the database named `mydb/autogen`
+            - If only `db=mydb` is provided (no `rp`), the query targets the database named `mydb`
+
+            Unlike InfluxDB v1 and Cloud Serverless, Cloud Dedicated does not use DBRP mappings or separate retention policy objects. This parameter exists solely for v1 API
+            compatibility and database naming conventions.
+
+            _Note: The retention policy name does not control data retention in Cloud Dedicated. Data retention is determined by the database's **retention period** setting._
+            
+            ### Related
+
+            - [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention)
+            - [InfluxQL data retention policy mapping differences](/influxdb3/cloud-serverless/guides/prototype-evaluation/#influxql-data-retention-policy-mapping-differences)
+        - 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 +317,83 @@ paths:
           text/plain:
             schema:
               type: string
+          application/json:
+            schema:
+              type: object
+              properties:
+                db:
+                  type: string
+                  description: |
+                    The database name for InfluxQL queries.
+
+                    Required parameter that specifies the database to query.
+                    In InfluxDB Cloud Dedicated, this can be either:
+                    - A simple database name (for example, `mydb`)
+                    - The database portion of a `database_name/retention_policy_name` naming convention (used together with the `rp` parameter)
+
+                    When used alone, `db` specifies the complete database name to query. When used with the `rp` parameter, they combine to form the full database name as `db/rp`--for example, if `db=mydb` and `rp=autogen`, the query targets the database named `mydb/autogen`.
+
+                    Unlike InfluxDB Cloud Serverless, Cloud Dedicated does not use DBRP mappings. The database name directly corresponds to an existing database in your Cloud Dedicated cluster.
+
+                    Examples:
+                    - `db=mydb` - queries the database named `mydb`
+                    - `db=mydb` with `rp=autogen` - queries the database named `mydb/autogen`
+
+                    _Note: The specified database must exist in your Cloud Dedicated cluster. Queries will fail if the database does not exist._
+
+                    ### Related
+
+                    - [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention)
+                    - [Migrate data from InfluxDB 1.x to Cloud Dedicated](/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated/)
+                    - [InfluxQL data retention policy mapping differences between InfluxDB Cloud Dedicated and Cloud Serverless](/influxdb3/cloud-serverless/guides/prototype-evaluation/#influxql-data-retention-policy-mapping-differences)
+                rp:
+                  description: |
+                    The retention policy name for InfluxQL compatibility
+
+                    Optional parameter that, when combined with the db parameter, forms the complete database name to query. In InfluxDB Cloud Dedicated, databases can be named using the
+                    database_name/retention_policy_name convention for InfluxQL compatibility.
+
+                    When a request specifies both `db` and `rp`, Cloud Dedicated combines them as `db/rp` to target the database--for example:
+
+                    - If `db=mydb` and `rp=autogen`, the query targets the database named `mydb/autogen`
+                    - If only `db=mydb` is provided (no `rp`), the query targets the database named `mydb`
+
+                    Unlike InfluxDB v1 and Cloud Serverless, Cloud Dedicated does not use DBRP mappings or separate retention policy objects. This parameter exists solely for v1 API
+                    compatibility and database naming conventions.
+
+                    _Note: The retention policy name does not control data retention in Cloud Dedicated. Data retention is determined by the database's **retention period** setting._
+
+                    ### Related
+
+                    - [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention)
+                    - [Migrate data from InfluxDB 1.x to Cloud Dedicated](/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated/)
+                    - [InfluxQL data retention policy mapping differences](/influxdb3/cloud-serverless/guides/prototype-evaluation/#influxql-data-retention-policy-mapping-differences)
+                  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 +430,7 @@ paths:
           schema:
             type: string
           required: true
-          description: Bucket to query.
+          description: Database to query.
         - in: query
           name: rp
           schema: