Fix OSS v2 /query compatibility API specs and examples #6088
+546
−240
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Adds missing examples for v1-compatible /query - Fixes curl params in examples - Removes unsupported async option from examples - Updates terms for consistency with branding and influxdb3 docs - Copies the missing POST /query operation from swaggerv1compat to the v2 ref.yml - Effectively removes the separate v1-compat spec, and adds redirects and tags for v1-compat endpoints in v2/ref.yml - Updates affected links
- OSS v2 supports partial writes and returns a 422 that describes rejected points, depending on the problem. - Update API spec - Move file to content/shared for Cloud
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR updates the OSS v2 /query compatibility API specs and examples, ensuring that the documentation and sample code accurately reflect the v1-compatible API endpoints and parameters. Key changes include revising endpoint and authentication details in the query examples, updating placeholder texts for clarity, and modifying port mappings in the InfluxDB 3 installation instructions.
Reviewed Changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| content/shared/influxdb-v2/query-data/execute-queries/influx-api.md | Revised API endpoint examples for Flux and InfluxQL queries and updated placeholder texts. |
| content/shared/influxdb-v2/api-guide/influxdb-1x/query.md | Updated wording to reference v1-compatible authorization and query parameters. |
| content/influxdb3/core/install.md | Changed port mapping from 9999 to 8181 for InfluxDB 3. |
| content/influxdb/v2/install/upgrade/v1-to-v2/manual-upgrade.md and automatic-upgrade.md | Updated wording from "1.x-compatible" to "v1-compatible" for consistency. |
| api-docs/influxdb/v2/v2/ref.yml, among other API docs | Adjusted tag names and descriptions to support the v1-compatible endpoints. |
Comments suppressed due to low confidence (1)
content/influxdb3/core/install.md:178
- Verify that the updated port mapping '8181:8181' is intentional and that all related documentation or configuration files are updated accordingly.
- 8181:8181
|
|
||
| - {{% code-placeholder-key %}}`ORG_ID`{{% /code-placeholder-key %}} - the ID of the [organization](/influxdb/version/admin/organizations/) that owns the bucket. | ||
| - {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}} - your [token](/influxdb/version/admin/tokens/). | ||
| - {{% code-placeholder-key %}}`BUCKET_NAME`{{% /code-placeholder-key %}} - the name of the [bucket](/influxdb/version/admin/buckets/) to create. |
There was a problem hiding this comment.
Consider updating the placeholder description from 'to create' to 'to query' or a similar phrase to better reflect the context of executing a query request.
Copilot uses AI. Check for mistakes.
jstirnaman
commented
May 23, 2025
content/shared/influxdb-v2/query-data/execute-queries/influx-api.md
Outdated
Show resolved
Hide resolved
jstirnaman
commented
May 23, 2025
content/shared/influxdb-v2/query-data/execute-queries/influx-api.md
Outdated
Show resolved
Hide resolved
jstirnaman
commented
May 23, 2025
content/shared/influxdb-v2/query-data/execute-queries/influx-api.md
Outdated
Show resolved
Hide resolved
jstirnaman
commented
May 23, 2025
content/shared/influxdb-v2/query-data/execute-queries/influx-api.md
Outdated
Show resolved
Hide resolved
sanderson
approved these changes
Jun 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
/queryexamples in OSS v2