Dustin Eaton
a0ea0fcb41
fix: use int64 for retention period in API spec
...
This updates the Cloud Dedicated Management API spec to use the `int64`
format for the `ClusterDatabaseRetentionPeriod` schema, which matches
the corresponding type in IOx's namespace API.
2024-06-04 16:16:02 -05:00
Jason Stirnaman
dbcb5dcac2
Apply suggestions from code review
...
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-05-10 15:21:30 -05:00
Jason Stirnaman
e16405282d
chore(v3): increase suggested wait for token activation
...
- part of https://github.com/influxdata/DAR/issues/425
- Tokens currently can take minutes to sync
- Add Notable behaviors to guides and references
2024-05-10 14:38:35 -05:00
Jason Stirnaman
0de7e563a3
feat(v3): Add influxctl cluster list and get task-based, and use them to find account ID and cluster ID for the HTTP API. Closes #5433
2024-04-19 11:58:17 -05:00
Jason Stirnaman
3d08263f38
fix(api): Update HTTP API landing page in Dedicated
...
- Adds a custom short title field in OpenAPI info.
- Uses the new field for nav menu item names.
- Adds identifiers to avoid duplicate name warnings.
- Cleans up variation in frontmatter.
2024-04-16 16:29:27 -05:00
Jason Stirnaman
ac4b1c53c8
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 17:02:12 -06:00