feat(influxdb3): rename API specs and add download links
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.feat/v3.8-api-specs
parent
765f669d06
commit
6818f25c51
|
|
@ -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.
|
||||
|
|
@ -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" \
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ x-influxdata-product-name: InfluxDB 3 Core
|
|||
|
||||
apis:
|
||||
v3@3:
|
||||
root: v3/ref.yml
|
||||
root: v3/influxdb3-core-openapi.yaml
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb3/core/api/
|
||||
- /influxdb3/core/api/v1/
|
||||
|
|
|
|||
|
|
@ -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'
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -7,7 +7,7 @@ x-influxdata-product-name: InfluxDB 3 Enterprise
|
|||
|
||||
apis:
|
||||
v3@3:
|
||||
root: v3/ref.yml
|
||||
root: v3/influxdb3-enterprise-openapi.yaml
|
||||
x-influxdata-docs-aliases:
|
||||
- /influxdb3/enterprise/api/
|
||||
- /influxdb3/enterprise/api/v1/
|
||||
|
|
|
|||
|
|
@ -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-enterprise-openapi.yaml)
|
||||
license:
|
||||
name: MIT
|
||||
url: 'https://opensource.org/licenses/MIT'
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue