Skip to content

feat(influxdb3): add v3.8 OpenAPI specs for Core and Enterprise #6906

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jstirnaman merged 1 commit into from
Mar 8, 2026
Merged

feat(influxdb3): add v3.8 OpenAPI specs for Core and Enterprise #6906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api-docs/generate-api-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ function generateHtml {
local specbundle=redoc-static_index.html
# Define the temporary file for the Hugo template and Redoc HTML.
local tmpfile="${productVersion}-${api}_index.tmp"

echo "Bundling $specPath"

# Use npx to install and run the specified version of redoc-cli.
Expand All @@ -83,9 +83,9 @@ function generateHtml {
--title="$title" \
--options.sortPropsAlphabetically \
--options.menuToggle \
--options.hideDownloadButton \
--options.hideHostname \
--options.noAutoAuth \
--options.hideDownloadButton \
--output=$specbundle \
--templateOptions.description="$shortDescription" \
--templateOptions.product="$productVersion" \
Expand Down
2 changes: 1 addition & 1 deletion api-docs/influxdb3/core/.config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ x-influxdata-product-name: InfluxDB 3 Core

apis:
v3@3:
root: v3/ref.yml
root: v3/influxdb3-core-openapi.yaml
Copy link

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After renaming the v3 spec entrypoint from v3/ref.yml to v3/influxdb3-core-openapi.yaml, there are still repo scripts that reference the old path and will now fail (for example api-docs/getswagger.sh writes to influxdb3/core/v3/ref.yml, and scripts/docs-cli/lib/api-doc-scanner.js reads api-docs/influxdb3/core/v3/ref.yml). Please update those references to the new filename(s) in this PR so tooling stays in sync with the config change.

Suggested change
root: v3/influxdb3-core-openapi.yaml
root: v3/ref.yml

Copilot uses AI. Check for mistakes.
x-influxdata-docs-aliases:
- /influxdb3/core/api/
- /influxdb3/core/api/v1/
Expand Down
5 changes: 1 addition & 4 deletions api-docs/influxdb3/core/v3/content/info.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,7 @@ description: |
- `/`: Compatibility endpoints for InfluxDB v1 workloads and clients
- `/api/v2/write`: Compatibility endpoint for InfluxDB v2 workloads and clients

<!-- TODO: verify where to host the spec that users can download.
This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/).
-->
[Download the OpenAPI specification](/openapi/influxdb3-core-openapi.yaml)
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'
Expand Down
Loading
Loading