* 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.
* fix: broken install URL. Closes#3122.
* fix: remove redoc-cli from package.json. Set redoc-cli@version specifier in generate-api-docs.sh instead. Remove the requirement to run yarn install just for redoc-cli.
* fix: update README with npx help.
* Update api-docs/README.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update api-docs/README.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* fix: replace prompt override option for compatibility with npm@6.
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* fix: broken install URL. Closes#3122.
* fix: remove redoc-cli from package.json. Set redoc-cli@version specifier in generate-api-docs.sh instead. Remove the requirement to run yarn install just for redoc-cli.
* fix: update README with npx help.
* Update api-docs/README.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update api-docs/README.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@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
kelseiv
Scott Anderson