Docs/5625 v1 get query endpoint #6274

MeelahMe · 2025-07-30T21:52:15Z

Closes #6271
Closes #6272
Closes #5625

Adding GET & POST/query endpoint to cloud-serverless, dedicated, and cluster swagger

Rebased/mergeable

…verless

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…ompat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jstirnaman

A few small, but important suggestions. Otherwise, looks good. Thanks for doing this!

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

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

api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

…Compat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

jstirnaman

Are these necessary?

Yes. InfluxQL is correct

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

…Compat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

…ta/docs-v2 into docs/5625-v1-get-query-endpoint

Copilot

Pull Request Overview

This PR adds GET and POST endpoint support for the /query endpoint to the InfluxDB v1 compatibility API documentation across three InfluxDB 3 products. The main purpose is to document both GET and POST query methods for the v1 HTTP API and update terminology from "bucket" to "database" for consistency.

Key changes:

Added comprehensive GET /query endpoint documentation with parameters, headers, and response schemas
Enhanced POST /query endpoint with JSON request body schema
Updated terminology from "bucket" to "database" throughout the documentation

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml	Added GET query endpoint and enhanced POST endpoint with JSON schema; updated bucket→database terminology
api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml	Added GET query endpoint and enhanced POST endpoint with JSON schema; updated bucket→database terminology
api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml	Added GET query endpoint and enhanced POST endpoint with JSON schema; updated bucket→database terminology

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

api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml

…Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jstirnaman

Thanks for improving the v1-compat docs. My suggestions add explanation about

DBRP mapping and the differences between Cloud Serverless and Cloud Dedicated/Clustered. I realized we need to do a better job making this explicit for anyone looking to migrate from v1.
Use of "bucket" in Cloud Serverless. Sorry if my earlier comment misled you. Cloud Serverless still uses "bucket" to be consistent with Cloud v2 terminology.

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

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

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

api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml

jstirnaman

We should do this in the other specs as well, but that's a separate issue.

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

…Compat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

…Compat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

MeelahMe added 2 commits July 30, 2025 14:39

feat: Add complete GET /query endpoint

cbdaaa0

feat: Add complete GET /query endpoint to cluster, dedicated, and ser…

9117e7a

…verless

MeelahMe requested review from Copilot and jstirnaman July 30, 2025 21:52

This comment was marked as outdated.

Sign in to view

MeelahMe requested a review from sanderson July 30, 2025 21:53

docs(api): enhance POST /query with JSON chunk parameter support

dbcd8dd

MeelahMe requested a review from Copilot July 30, 2025 22:37

This comment was marked as outdated.

Sign in to view

MeelahMe added the API label Jul 31, 2025

MeelahMe self-assigned this Jul 31, 2025

MeelahMe and others added 6 commits July 31, 2025 23:21

Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml

105a06b

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml

ed7fa90

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1…

aa766ed

…Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1…

e9bbdf1

…Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1C…

e772317

…ompat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1C…

33ace56

…ompat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jstirnaman requested changes Aug 1, 2025

View reviewed changes

MeelahMe and others added 7 commits August 1, 2025 13:42

Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1C…

36085a8

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1C…

7cc0c38

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1C…

6ba77d4

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1C…

6efb013

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1…

6a20bb0

…Compat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml

3b738ec

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Merge branch 'master' into docs/5625-v1-get-query-endpoint

a038d07

MeelahMe requested review from jstirnaman and removed request for sanderson August 1, 2025 20:57

jstirnaman requested changes Aug 1, 2025

View reviewed changes

api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml Outdated Show resolved Hide resolved

Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1…

76af766

…Compat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

MeelahMe removed the request for review from jstirnaman August 5, 2025 20:49

MeelahMe added 3 commits August 5, 2025 13:52

docs: updating rp for cluster and serverless

5ef4d2e

Merge branch 'docs/5625-v1-get-query-endpoint' of github.com:influxda…

78ecb89

…ta/docs-v2 into docs/5625-v1-get-query-endpoint

docs: updates to clous-serveless rp

ae96f01

MeelahMe requested a review from Copilot August 5, 2025 21:36

Copilot AI reviewed Aug 5, 2025

View reviewed changes

MeelahMe and others added 3 commits August 5, 2025 14:38

Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1…

a215776

…Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1…

65e80ca

…Compat.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml

9ee11d3

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

MeelahMe requested a review from jstirnaman August 5, 2025 21:42

jstirnaman requested changes Aug 6, 2025

View reviewed changes

jstirnaman self-requested a review August 6, 2025 16:51

jstirnaman requested changes Aug 6, 2025

View reviewed changes

MeelahMe and others added 12 commits August 6, 2025 09:54

Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1C…

6fb6454

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1C…

ce5d929

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1C…

89db6cd

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1…

bc890e4

…Compat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1…

a69fea8

…Compat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1…

c6bd7bb

…Compat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1C…

4d77cde

…ompat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml

33cae0b

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml

4f0a718

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Merge branch 'master' into docs/5625-v1-get-query-endpoint

fe1dd29

Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1…

beb7bb2

…Compat.yml Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

Merge branch 'master' into docs/5625-v1-get-query-endpoint

2935571

jstirnaman approved these changes Aug 14, 2025

View reviewed changes

jstirnaman and others added 2 commits August 14, 2025 16:31

Merge branch 'master' into docs/5625-v1-get-query-endpoint

f8a8207

minor updates to requestBody to fix Ci build error

144de57

MeelahMe merged commit 3558b7c into master Aug 14, 2025
5 checks passed

MeelahMe deleted the docs/5625-v1-get-query-endpoint branch August 14, 2025 22:03

Docs/5625 v1 get query endpoint #6274

Docs/5625 v1 get query endpoint #6274

Uh oh!

Conversation

MeelahMe commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

jstirnaman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jstirnaman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jstirnaman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jstirnaman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MeelahMe commented Jul 30, 2025 •

edited

Loading