Closed jstirnaman closed 4 months ago
(I expect to do future work to streamline the docs generation and simplify the config.)
This PR closes #5397 with the following changes:
Adds an API reference doc for the HTTP management API openapi spec (https://github.com/influxdata/granite/blob/main/openapi.yaml) (Cloud Dedicated only), hidden from sitemap and menus.
Adds Management API examples from https://raw.githubusercontent.com/influxdata/granite/aea169033af0d7f7d6124c1a3cab61c085038bd2/scripts/test_http_api_v0_endpoints.sh
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)
Improves Hugo frontmatter descriptions and reuses titles and summaries from specs.
Restructures /api-docs to better allow for multiple APIs (and customizations) per product
/api-docs
Adds [product]/api/v2/ docs URL for cloud products (currently set as the "default" API, [product]/api)
[product]/api/v2/
[product]/api
Refactors generate-api-docs to remove specific conditions and use the new directory structure.
generate-api-docs
Redocly update fixes some theme formatting issues
Tested with the following URLs:
Ah, wait, that's not supposed to show in the menu :/
Fixed.
(I expect to do future work to streamline the docs generation and simplify the config.)
This PR closes #5397 with the following changes:
Adds an API reference doc for the HTTP management API openapi spec (https://github.com/influxdata/granite/blob/main/openapi.yaml) (Cloud Dedicated only), hidden from sitemap and menus.
Adds Management API examples from https://raw.githubusercontent.com/influxdata/granite/aea169033af0d7f7d6124c1a3cab61c085038bd2/scripts/test_http_api_v0_endpoints.sh
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)
Improves Hugo frontmatter descriptions and reuses titles and summaries from specs.
Restructures
/api-docs
to better allow for multiple APIs (and customizations) per productAdds
[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 with the following URLs: