Implement the x-tags extension for schema objects
#837
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A few of the types in the `sidebars/index.ts` page have been changed to allow for more proper typing of both api items and schema items.
|
Visit the preview URL for this PR (updated for commit b66371b): https://docusaurus-openapi-36b86--pr837-y87n5vtc.web.app (expires Sun, 14 Jul 2024 14:58:49 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
|
LGTM! |
sserrata
pushed a commit
that referenced
this pull request
Jun 18, 2024
* introduce x-tags onto SchemaObject type, and revise sidebar types A few of the types in the `sidebars/index.ts` page have been changed to allow for more proper typing of both api items and schema items. * add schemas with x-tags into the tag category sidebar slice * add schemas with x-tags even if showSchemas is not true * add a badge and some styling for schema sidebar labels * add some test coverage * add some x-tags documentation to `sidebars.md` * update documentation on styling sidebar items * include schema-only tags, just like operation-only ones * add the pet x-tag to the Cat schema for demo purposes * filter out x-tagged schemas from the "Schemas" category they'll already be displayed elsewhere
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change enables schemas to have
x-tagsdefined for them, which allows them to be grouped alongside related path objects whensidebarOptions.groupPathsBy: 'tag'is configured.Motivation and Context
In reporting the unexpected behavior in #836, I began poking around and discovered the
x-tagsextension by redocly. It seems like a useful feature, and was easy enough to get working.It's intended (by redocly, and so here) that it's a "competing" option for configuring
showSchemas: true, which is why you'll see some changes to the checks/logic inopenapi/openapi.tssurrounding if/when to add schema objects to the sidebar slice.How Has This Been Tested?
Tested this on my local computer, using the demo app. I've added (only locally, I think)
x-tagsto a few of the defined schemas, and made sure they show up where they belong.Screenshots (if appropriate)
Types of changes
Checklist