* 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
Scott Anderson
Kelly