Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/api-docs/cloud-serverless/.config.yml

14 lines
273 B
YAML
Raw Normal View History

feat(v3): Restructure API docs for v3 (#5408) * v3 management API Fixes #5397 - Adds an API reference doc for the HTTP management API openapi spec (https://github.com/influxdata/granite/blob/main/openapi.yaml) (Cloud Dedicated only) - Doesn't fetch changes for any specs except for the Management spec. - Adds summaries and fixes descriptions in spec overrides. - Removes versions in spec overrides. - Adds configuration for generating API reference docs, Hugo frontmatter, setting the default API (for the [product]/api/ URL) - Restructures `/api-docs` to better allow for multiple APIs (and customizations) per product - Adds `[product]/api/v2/` docs URL for cloud products (currently set as the "default" API, `[product]/api`) - Refactors `generate-api-docs` to remove specific conditions and use the new directory structure. - Redocly update fixes some theme formatting issues - Tested the following URLs: - http://localhost:1313/influxdb/v2/api/ - http://localhost:1313/influxdb/v2/api/v1-compatibility/ - http://localhost:1313/influxdb/cloud/api/ - http://localhost:1313/influxdb/cloud/api/v2/ - http://localhost:1313/influxdb/cloud-dedicated/api/ - http://localhost:1313/influxdb/cloud-dedicated/api/v2/ - http://localhost:1313/influxdb/cloud/api/v1-compatibility/ - http://localhost:1313/influxdb/cloud-dedicated/api/v1-compatibility/ - http://localhost:1313/influxdb/cloud-serverless/ - http://localhost:1313/influxdb/cloud-serverless/api/v2/ - http://localhost:1313/influxdb/cloud-serverless/api/v1-compatibility/ - http://localhost:1313/influxdb/clustered/api/ - http://localhost:1313/influxdb/clustered/api/v2/ - http://localhost:1313/influxdb/clustered/api/v1-compatibility/ * fix(v3): Remove Management API from menu * Update api-docs/cloud-dedicated/v2/content/info.yml * show management api in nav, update nav names --------- Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> Co-authored-by: Scott Anderson <scott@influxdata.com>
2024-04-09 23:02:12 +00:00
plugins:
- '../openapi/plugins/docs-plugin.js'
extends:
- recommended
- docs/all
x-influxdata-product-name: InfluxDB v3 Serverless
apis:
v2@2:
root: v2/ref.yml
x-influxdata-default: true
v1-compatibility@2:
root: v1-compatibility/swaggerV1Compat.yml