* 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>
Jason Stirnaman