docs-v2

Commit Graph

Author	SHA1	Message	Date
Scott Anderson	b15574fd8c	Update api-docs/cloud-dedicated/v2/content/info.yml	2024-04-09 15:17:33 -06:00
Jason Stirnaman	e352f93bef	fix(v3): Remove Management API from menu	2024-04-05 19:27:38 -05:00
Jason Stirnaman	cf4fa82f4d	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/	2024-04-05 18:33:48 -05:00
Jason Stirnaman	d61107a3d3	feature(v3): Cloud Dedicated write API: partial writes write good lines and reject bad li… (#5273 ) * feature(v3): Write: partial writes write good lines and reject bad lines #5160 - Documents the proposed partial writes feature for Serverless and Dedicated. - Updates Troubleshoot writes and API docs. * chore(v3): update write status codes (#5160) * Update content/influxdb/cloud-serverless/write-data/troubleshoot.md * chore(v3): cleanup partial write descriptions in API ref and troubleshooting guide	2023-12-18 12:43:44 -06:00
Jason Stirnaman	fa9bba758e	chore(api): add API compatibility overview to API ref (#5192 ) * chore(api): add API compatibility overview to API ref - add API compatibility trait tag - add getswagger -B option to reuse existing contract and prevent fetching - add /write description * Update api-docs/cloud-dedicated/ref.yml Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update api-docs/cloud-dedicated/ref.yml Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update api-docs/clustered/ref.yml Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update api-docs/clustered/ref.yml Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> --------- Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>	2023-10-25 11:35:38 -05:00
Jason Stirnaman	e0bafcd9a1	fix: fix v3 write descriptions, Add v3 Troubleshoot writing data #5135 (#5140 ) * fix: fix v3 write descriptions, Add v3 Troubleshoot writing data #5135 * Update content/influxdb/cloud-dedicated/write-data/troubleshoot.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/cloud-serverless/write-data/troubleshoot.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update content/influxdb/clustered/write-data/troubleshoot.md Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> --------- Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>	2023-09-18 13:03:47 -05:00
Jason Stirnaman	6e01923a81	chore(api-ref): update API ref scripts for v3: (#4949 ) * chore(api-ref): update API ref scripts for v3: - Replace cloud-iox with cloud-serverless and cloud-dedicated in getswagger.sh - Add cloud-dedicated API ref (handcrafted) with query, write, and ping paths. - Remove separate v1-compat docs for Serverless and Dedicated. The v1 paths are included in contracts/ref. - Add Bearer Auth scheme. - Remove separate v1 docs buttons from api/_index.md * Update api-docs/cloud-dedicated/ref.yml Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com> * Update api-docs/cloud-dedicated/ref.yml --------- Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>	2023-05-23 13:52:45 -05:00

7 Commits (jstirnaman/issue5397-managementapi)