Commit Graph

5 Commits (274d4a0444b249bb7dcefc9592fc75ce9eef55db)

Author SHA1 Message Date
Jason Stirnaman 8129c5b4c5
fix for reverted 4788 build the http api reference for iox relevant endpoints (#4803)
* 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>
2023-03-15 11:36:17 -05:00
Jason Stirnaman 63b524bf0b
Revert "4788 build the http api reference for iox relevant endpoints (#4801)" (#4802)
This reverts commit da6c2e467d.
2023-03-15 10:36:14 -05:00
Jason Stirnaman da6c2e467d
4788 build the http api reference for iox relevant endpoints (#4801)
* 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>
2023-03-15 10:20:56 -05: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
Scott Anderson 0775371951
InfluxDB v2.6.0 (#4672)
* created 2.6 docs set

* fixed config.toml file

* fixed taxonomies

* fixed 2.6 file strucure

* added CLI 2.6 release notes (#4668)

* New influxd inspect commands (#4670)

* added new influxd inspect commands

* updated the index page with new commands

* Apply suggestions from code review

* added examples for influxd inspect report-db

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

* OSS 2.6 release notes (#4669)

* WIp release notes

* WIP release notes

* added links

* added detail

* Update content/influxdb/v2.6/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.6/reference/release-notes/influxdb.md

Co-authored-by: Jeffrey Smith II <jeffreyssmith2nd@gmail.com>

* minor updates to release notes

* minor updates to previous release notes

* more minor updates to release notes

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Jeffrey Smith II <jeffreyssmith2nd@gmail.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>

* fixed typos

* add 2.6 openapi spec (#4671)

* fix all 2.6 links in 2.5

Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
Co-authored-by: Jeffrey Smith II <jeffreyssmith2nd@gmail.com>
2022-12-15 16:43:27 -07:00