* 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>
* 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>
* feature(cloud-iox): add cloud-iox API reference content.
* feature(api): revise tagging, add cloud-iox API:
- Closes#4788.
- Generates cloud-iox/api.
- Changes handling of tags and x-tagGroups.
- Configures custom All Endpoints list for cloud-iox.
- Simplifies the nav with other grouping tags.
Any custom x-tagGroups configured in
[platform]/content/tag-groups.yml take precedence over
those already defined in the spec.
If you assign a list of tags to 'All endpoints' x-tagGroup,
the decorator
will use that list and remove Operations not tagged with
those tags.
If you assign an empty array([]) to the 'All endpoints' x-tagGroup,
the decorator will list all resource-like tags.
TODO: document in CONTRIBUTING.
TODO: unset x-tagGroups from openapi.
* Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* fix(api): unintended deletion of API operations
---------
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* feature(cloud-iox): add cloud-iox API reference content.
* feature(api): revise tagging, add cloud-iox API:
- Closes#4788.
- Generates cloud-iox/api.
- Changes handling of tags and x-tagGroups.
- Configures custom All Endpoints list for cloud-iox.
- Simplifies the nav with other grouping tags.
Any custom x-tagGroups configured in
[platform]/content/tag-groups.yml take precedence over
those already defined in the spec.
If you assign a list of tags to 'All endpoints' x-tagGroup,
the decorator
will use that list and remove Operations not tagged with
those tags.
If you assign an empty array([]) to the 'All endpoints' x-tagGroup,
the decorator will list all resource-like tags.
TODO: document in CONTRIBUTING.
TODO: unset x-tagGroups from openapi.
* Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
---------
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* 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>
* chore: update property names in redocly config.
* chore(api): lint the bundle output for openapi spec errors, set Cloud version, rename variable.
- Runs openapi-cli lint after generating the bundle output. This detects errors before pushing to openapi repo only to have the CI OATS validation fail. Only report the first 2 errors so we're not inundated with non-critical warnings.
- Renames INFLUXDB_VERSION to INFLUXDB_PLATFORM for clarity.
- Add a Cloud version to make the spec legal.
* chore: getswagger quality-of-life
- Exit on invalid options.
- Show curl output, e.g. if the filepath is incorrect.
- Replace $_ with $outFile for readability.
- Replace context with platform, the common jargon.
* chore(api): generate.sh quality-of-life
- Only regenerate HTML for a spec version if the current file differs from master.
- Refactor to remove code repetition.
* chore: generate.sh generates all versions by default
- Add a -c flag that only generates changed files (for development).
- More refactoring.
* chore: getswagger quality-of-life
- Exit on invalid options.
- Show curl output, e.g. if the filepath is incorrect.
- Replace $_ with $outFile for readability.
- Replace context with platform, the common jargon.
* chore(api): generate.sh quality-of-life
- Only regenerate HTML for a spec version if the current file differs from master.
- Refactor to remove code repetition.
* 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, closesinfluxdata/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, closesinfluxdata/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>
* fix: oss and cloud auth. Add bearer scheme for OSS.
* chore: Add an openapi CLI decorator that replaces INFLUXDB_DOCS_URL 'shortcodes' with the correct URL in specs.
* fix: API authentication descriptions and schemes in /api/v2 and V1Compat. Remove QueryString and Basic auth schemes from /api/v2 and add them to V1Compat, along with Token auth. Hook up the replace-docs-url-shortcode which is primarily for V1Compat for now due to the way that contract is managed. Add tag groups to V1Compat.
* fix: add v1compat Info description. Comment out Bearer auth in OSS until it's available in Cloud.
* fix: add replace-shortcodes decorator. Fix v1-compat tag-groups. Fix spec titles.
* fix: restore BasicAuth scheme definition for the users operations that reference them. Still need examples for these.
* fix: remove 1.x BasicAuth references where they don't belong.
* chore: sync from openapi master.
* fix: use replace-shortcodes to replace full Docs URLs in the contracts with absolute local paths to avoid roundtrips. Improve v1compat titles.
* Update api-docs/cloud/swaggerV1Compat.yml
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update api-docs/cloud/swaggerV1Compat.yml
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update api-docs/cloud/swaggerV1Compat.yml
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update api-docs/cloud/swaggerV1Compat.yml
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update api-docs/cloud/swaggerV1Compat.yml
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* 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.
* feat: add api-guides/guides and guides/api-invocable-scripts for the API-invocable scripts (managed functions) feature (##2547, #2233).
* feat: document API-invocable scripts. Add example for creating and invoking a script with POST. Unable to make GET work with query parameters.
* feat: moved API-invocable scripts under api-guide. Remove guides directory. Add docs for list and find. Add example for list. Add shortcuts and glossary links. Verified with team-compute that GET /invoke and python are not supported yet.
* feat: rename example function for simplicity since there's no GET for now.
* feat: add find_and_update example (#2547).
* feat: add update example. Clarify, expand invoke example. Add links. (#2547)
* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* fix: remove accidental commit of generated redoc-static.html
* feat: manual update to cloud swagger. Merges meta, auth, tags, and x-tagGroups from src/cloud.yml to aggregate contracts/ref/cloud.yml.
* fix: replace /functions with /scripts
* feat: get swaggers from contracts/ref. Still requires copy-paste of info, tags, and auth from contracts/cloud.yml and contracts/oss.yml
* feat: invocable scripts (#2547)
* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* feat: new section for params (#2547).
* fix: swagger server url (#2547)
* Update content/influxdb/cloud/api-guide/api-invocable-scripts/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* feat: remove jq and function where there's no clear need.
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
* Added hugo-extended, postcss, postcss-cli, and autoprefixer as devDependencies. Run npm install or yarn install. (#2474)
* Replaced global hugo and yarn installs with project-level yarn install.
* Replaced npm package.lock with yarn.lock (#2474).
* enhancement: update README with instructions for installing NODE.JS dependencies. (#2474)
* updated api doc generator script to use npx
* Update README.md
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* Update README.md
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* Update README.md
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* Update README.md
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
* Update README.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update package.json
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* fix: indentation. (#2476)
* update: Added separate dependencies list for api-docs.
- Moved redoc-cli to a separate package.json in api-docs. Excluded
api-docs/node_modules from generate-api-docs.sh.
- Updated redoc-cli argument sequence to agree with their docs.
- Updated READMEs.
- Fixed typos.
* update: add api-docs > yarn install to .circleci
* Added language and consistency to code block. Specify where to run the command.
Co-authored-by: Scott Anderson <scott@influxdata.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Jason Stirnaman
Jason Stirnaman
kelseiv
Scott Anderson
Kelly