docs-v2

Commit Graph

Author	SHA1	Message	Date
Jason Stirnaman	8acbb22312	fix: add missing partial and schema descriptions for InfluxQL JSON response - Closes #5364 - part of https://github.com/influxdata/DAR/issues/424 - depends on https://github.com/influxdata/openapi/pull/651	2024-05-16 12:48:55 -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
Jason Stirnaman	5230b11796	fix(v2): (Closes #5320 ) Remove attribute from OSS /api/v2/query schema. OSS doesn't support parameterized queries. See upstream PR: https://github.com/influxdata/openapi/pull/646 (#5325 )	2024-02-15 17:20:57 -06:00
Andreas Deininger	c9488e3465	Fixing typos (#5242 ) * Fixing typos * Update content/enterprise_influxdb/v1/flux/guides/rate.md --------- Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>	2023-11-27 09:32:55 -07: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
Scott Anderson	35ad46c4c2	Version restructure (#5133 ) * mass changes for version restructure * fixed latest-patch and flux version generator * updated hugo configs * fixed flux frontmatter injector * fixed flux frontmatter injector * WIP api generator updates for version restructure (#5128) * fixed telegraf plugin list * removed latest shortcode * fixed current-version * fixed product dropdown crosslinking * fixed alt links * WIP fixing links * fixed broken links * updated api doc generation * fixed additional resources * added version redirects to edge.js * fixed search placeholder * fixed paged titles	2023-09-12 23:33:31 -06:00

8 Commits (master)