Commit Graph

4 Commits (7fd469306b72d8d363d0d7ee4e9eca8bece08ea0)

Author SHA1 Message Date
sunbryely-influxdata 03f9183ba6
feat: add MIT license to api content (#4401)
* feat: add MIT license to api content

* chore: whitespace

Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MacBook-Pro.local>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2022-09-01 17:15:51 -05:00
Jason Stirnaman 064d9d0a25
chore/api-tags flatten tags (#4191)
* chore(api):

- Replace some x-tagGroups with tags to flatten the navigation and redundant headings.
- Remove unnecessary x-tagGroups from 1.x compat docs.

* chore: remove unused tag-group files.

* chore: update api-docs README

- Document the generate -c flag.
- Cleanup.

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-07-12 12:21:35 -05:00
Jason Stirnaman 2468a7675e
fix: replace download button with spec link. (#4013)
- Closes #3810 - Remove download button and add a link to the spec source in Github.
2022-05-12 16:48:02 -05:00
Jason Stirnaman b100bbf256
Fix/api securityschemes (#3488)
* 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>
2021-12-21 14:34:49 -06:00