Skip to content

Commit e1e7e22

Browse files
authored
feat(influxdb3): rename API specs and add download links (#6906)
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.
1 parent 765f669 commit e1e7e22

File tree

9 files changed

+11673
-3339
lines changed

9 files changed

+11673
-3339
lines changed

api-docs/generate-api-docs.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ function generateHtml {
7070
local specbundle=redoc-static_index.html
7171
# Define the temporary file for the Hugo template and Redoc HTML.
7272
local tmpfile="${productVersion}-${api}_index.tmp"
73-
73+
7474
echo "Bundling $specPath"
7575

7676
# Use npx to install and run the specified version of redoc-cli.
@@ -83,9 +83,9 @@ function generateHtml {
8383
--title="$title" \
8484
--options.sortPropsAlphabetically \
8585
--options.menuToggle \
86-
--options.hideDownloadButton \
8786
--options.hideHostname \
8887
--options.noAutoAuth \
88+
--options.hideDownloadButton \
8989
--output=$specbundle \
9090
--templateOptions.description="$shortDescription" \
9191
--templateOptions.product="$productVersion" \

api-docs/influxdb3/core/.config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ x-influxdata-product-name: InfluxDB 3 Core
77

88
apis:
99
v3@3:
10-
root: v3/ref.yml
10+
root: v3/influxdb3-core-openapi.yaml
1111
x-influxdata-docs-aliases:
1212
- /influxdb3/core/api/
1313
- /influxdb3/core/api/v1/

api-docs/influxdb3/core/v3/content/info.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,7 @@ description: |
2121
- `/`: Compatibility endpoints for InfluxDB v1 workloads and clients
2222
- `/api/v2/write`: Compatibility endpoint for InfluxDB v2 workloads and clients
2323
24-
<!-- TODO: verify where to host the spec that users can download.
25-
This documentation is generated from the
26-
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/).
27-
-->
24+
[Download the OpenAPI specification](/openapi/influxdb3-core-openapi.yaml)
2825
license:
2926
name: MIT
3027
url: 'https://opensource.org/licenses/MIT'

0 commit comments

Comments
 (0)