feat(influxdb3): add v3.8 OpenAPI specs for Core and Enterprise#6906
feat(influxdb3): add v3.8 OpenAPI specs for Core and Enterprise#6906jstirnaman merged 1 commit intomasterfrom
Conversation
Rename Core and Enterprise OpenAPI spec files from ref.yml to descriptive names (influxdb3-core-openapi.yaml, influxdb3-enterprise-openapi.yaml). Copy specs to static/openapi/ and add download links in the API description.
jstirnaman
requested review from
Copilot and
sanderson
and removed request for
a team and
sanderson
|
There was a problem hiding this comment.
Pull request overview
This PR updates the InfluxDB 3 Core and Enterprise API reference to use newly generated v3.8 OpenAPI specs, and exposes those specs as downloadable static assets under /openapi/.
Changes:
- Replaces
ref.yml-based v3 specs withinfluxdb3-*-openapi.yamlspecs for Core and Enterprise. - Adds explicit download links in the rendered API reference descriptions pointing to
/openapi/.... - Adds static copies of the OpenAPI specs under
static/openapi/for direct download.
Reviewed changes
Copilot reviewed 5 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| static/openapi/influxdb3-enterprise-openapi.yaml | Adds Enterprise v3.8 OpenAPI spec as a downloadable static file. |
| api-docs/influxdb3/enterprise/v3/influxdb3-enterprise-openapi.yaml | Adds Enterprise v3.8 OpenAPI spec used by the API docs build. |
| api-docs/influxdb3/enterprise/v3/content/info.yml | Updates the API reference description to link to the downloadable spec. |
| api-docs/influxdb3/enterprise/.config.yml | Points the Enterprise v3 API docs config at the new spec filename. |
| api-docs/influxdb3/core/v3/content/info.yml | Updates the API reference description to link to the downloadable spec. |
| api-docs/influxdb3/core/.config.yml | Points the Core v3 API docs config at the new spec filename. |
| api-docs/generate-api-docs.sh | Keeps Redoc bundling options aligned (no behavioral change intended). |
You can also share your feedback on Copilot code review. Take the survey.
| apis: | ||
| v3@3: | ||
| root: v3/ref.yml | ||
| root: v3/influxdb3-core-openapi.yaml |
There was a problem hiding this comment.
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.
| root: v3/influxdb3-core-openapi.yaml | |
| root: v3/ref.yml |
| apis: | ||
| v3@3: | ||
| root: v3/ref.yml | ||
| root: v3/influxdb3-enterprise-openapi.yaml |
There was a problem hiding this comment.
After renaming the v3 spec entrypoint from v3/ref.yml to v3/influxdb3-enterprise-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/enterprise/v3/ref.yml, and scripts/docs-cli/lib/api-doc-scanner.js reads api-docs/influxdb3/enterprise/v3/ref.yml). Please update those references to the new filename(s) in this PR so tooling stays in sync with the config change.
There was a problem hiding this comment.
@copilot update the scripts to use the new file names
|
@jstirnaman I've opened a new pull request, #6907, to work on those changes. Once the pull request is ready, I'll request review from you. |
Summary
ref.ymltoinfluxdb3-core-openapi.yamlandinfluxdb3-enterprise-openapi.yaml/openapi/static filesstatic/openapi/for direct download accessSpecs generated and renamed in influxdata/docs-tooling/pull/40.
The spec-driven contract test (contract-test.test.js) validates these specs against live servers:
Test plan
yarn run build:api-docs/influxdb3/core/api/v3/and/influxdb3/enterprise/api/v3//openapi/influxdb3-core-openapi.yamland/openapi/influxdb3-enterprise-openapi.yamlCloses https://github.com/influxdata/DAR/issues/625