Commit Graph

4 Commits (fix-api-ref-paths)

Author SHA1 Message Date
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 f431862a4a
Fix api version (#4697)
* chore: remove unused and deprecated properties:

- Remove unused apis key.
- Remove deprecated styleguide property, replace with root-level plugins and extends.

* chore: pass api-docs path to the custom plugin:

- Pass pwd of the calling script as process.env.API_DOCS_ROOT_PATH to plugins to help resolve custom content files.
- Remove lint execution because the exit code always results in execution of the next elif condition.

* chore: simplify api-docs custom content:

- move content overrides from api-docs/openapi/content to api-docs/[version]/content.
- fix version and version numbers in links.
- update cloud and v2.6 from openapi repo.
- move content.js module to docs-content.js and docs-plugin.js.
- revert decorator functions back to taking content as a data argument.
- remove unused servers.yml definition.

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-01-11 13:03:21 -07:00
kelseiv d674758ec0
base update to 2.2 (#3744)
* base update to 2.2

* draft release notes

* draft InfluxDB 2.2 release notes

* move release notes to new PR

* update api for 2.2

* fix menu items

* Update data/products.yml

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update data/products.yml

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* frontmatter fixes

* Feat/oss v2 2 metrics (#3762)

* feat: copy v2.1 metrics to v2.2.

* feat: new storage metrics in v2.2

* feat: v2.2 storage metrics.

* fix: revert 2.1 paths.

* Update "Get started with tasks" (#3763)

* update get started with tasks, closes influxdata/DAR#272

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* update nats config options, update influxd-flags logic, related to #3766 (#3771)

* updated token create API examples, closes influxdata/DAR#267 (#3773)

* ported scalar values update to 2.2

* Chore/move openapicli process (#3801)

* Internal measurements for monitoring Enterprise (#3698)

* Add 1.21.4 (#3789)

* Add 1.21.4

* Update content/telegraf/v1.21/about_the_project/release-notes-changelog.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Add apt and knot plugins

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* InfluxDB Enterprise 1.9.6 (#3650)

* Document meta-node HTTP access logging (#3486)
* Document `influxd-ctl backup -estimate` flag (#3484)
  Closes #3480
* add new option for SIGTERM (#3496)
* Document `-meta-only-overwrite-force` restore flag for Enterprise (#3487)
* Document `max-concurrent-deletes` option (#3697)
* Update Enterprise cluster metrics: add `openConnections` (#3703)
  Closes #3653
* Remove marketplace offerings from Enterprise
* Use bytes in certain Enterprise config examples (#3743)
* InfluxDB Enterprise 1.9: remove default values from configuration headings (#3759)

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Sam Arnold <sarnold@influxdata.com>

* fix: bad link. (#3793)

* Update products.yml

* Feat/3411 link to cloud limits (#3795)

* feat: link from write error responses to related Cloud limits topics.

* feat: link Troubleshooting writes to Cloud limits.

* fix: grammar.

* Update content/influxdb/cloud/write-data/troubleshoot.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* First updates for the new brand (#3796)

* first pass with new branding, logos, fonts

* updated table font sizes

* removed unnecessary file

* Update assets/styles/layouts/_sidebar.scss

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* a few last style updates

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* chore: move openapi-cli postprocessing to the getSwagger step.

* chore: convert the content generators to functions so they're not executed on import (which broke the linter). Move the generators into the decorators and remove options args to simplify. Update and simplify the README. Update the oss v2.1 contract.

* README

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Sam Arnold <sarnold@influxdata.com>

* port menu url fix from master to 2.2

* Feat/oss 2 2 config (#3774)

* wip: add new server-config CLI command and /api/v2/config path. Fix Operator token doc. (#3523)

* feat: document OSS-only  and . Deprecate assets-path: ""
(closes #3523)

* chore: add toc

* Replace run-time with runtime. (#3774)

* Update content/influxdb/v2.2/reference/cli/influx/server-config/_index.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* formatted all flux examples in influxdb 2.2

* Fix/set tag groups (#3823)

* fix: replacement of Info: in contracts.
fix: add missing const declarations.
fix: add a decorator to remove redundant servers with empty URLs
  -- all servers should be root now since paths are explicit.

* fix: invalid mix of tags as strings and objects in root.tags. Convert all tags to objects with a default description.

* fix: use tag objects instead of mixing strings and objects in x-tagGroups -- fixes validation errors.

* port data retention and deletion updates to 2.2

* ported updated current version shortcode to 2.2

* Feat/3414 v2.2 debug pprof (#3844)

* feat: update API reference for OSS v2.2. Adds /debug/pprof.

* feat: add v2.2 runtime reference.

* fix: update URLs.

* port hardening-enabled config info, closes #3867, closes #3866 (#3873)

* Fix/3855 oss2.2 (#3857)

* fix: update npm example in v2.2. (#3855)

* fix: cardinality for ossv2.2 (#3850)

* updating placeholders in 2.2

* Document `influx remote` and `influx replication` (#3469)

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* ported migration docs into 2.2

* updated edge.js

* porting various minor changes into 2.2

* InfluxDB 2.2 release notes (#3745)

* draft 2.2 release notes
* remove flux lines; regroup other items
* update link to Flux RNs
* update release notes
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
* fix frontmatter
* fix link; update version
* edit
* revert for review clarity
* Update influxdb.md
* note about technical preview & feature overview
* edit from Jason
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* Updates per Tim H and Sam feedback
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* changes made from feedback
* changed technical preview notes
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* add link to OSS metrics page
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* Add security section to influxdb/v2.2/reference/release-notes/influxdb.md (#3898)
* edits from Sam
* edit from sam
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.m
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* edits
* Update content/influxdb/v2.2/reference/release-notes/influxdb.md
Co-authored-by: Sam Dillard <sam@influxdata.com>
* edit from Sam
* edit from Sam
* edits from Tim
Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Jamie Strandboge <jamie@strandboge.com>
Co-authored-by: Sam Dillard <sam@influxdata.com>

* Recover credentials (#3915)

* draft recover creds
* add relate
* add new option to index
* Update content/influxdb/v2.2/users/recover-credentials.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/users/recover-credentials.md
* edit from SamA; add note
* sync headers
* add overview bullets; update links
* context from SamA
* Update content/influxdb/v2.2/users/recover-credentials.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/users/recover-credentials.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.2/users/recover-credentials.md
Co-authored-by: Sam Dillard <sam@influxdata.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Sam Dillard <sam@influxdata.com>

* update couple stray versions

* add technical preview to the glossary

* update release date

* fix link

* Add documentation for replications max-age (#3936)

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: noramullen1 <42354779+noramullen1@users.noreply.github.com>
Co-authored-by: Sam Arnold <sarnold@influxdata.com>
Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MacBook-Pro.local>
Co-authored-by: sunbryely-influxdata <101659702+sunbryely-influxdata@users.noreply.github.com>
Co-authored-by: Dane Strandboge <dane@strandboge.com>
2022-04-06 15:07:21 -07:00
Jason Stirnaman 2bddffb52b
API Ref docs processing (#3337)
* chore: API Reference Docs custom processing. Pulls contracts/ref files and applies custom content (tags, x-tagGroups, securitySchemes, info) before writing results to cloud/ref.yml and v2.0/ref.yml.
Rename source files from swagger.yml to ref.yml to avoid confusion and in case we need to bundle additional specs in the future.
Add an OpenAPI CLI docs-plugin with content and decorators.

* chore: update api-docs/README.md

* fix: add strip-version-prefix to remove /api/v2 added incorrectly to some paths during contract generation - also fixed in openapi repo so future contracts won't need this decorator. Fix server urls. Cleanup.

* chore: update cloud contract.
2021-11-03 14:18:02 -05:00