[Enhancement] Add vendor extension support for positioning sidebar items #1160
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
|
Size Change: 0 B Total Size: 2.14 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 91aaf76): https://docusaurus-openapi-36b86--pr1160-xip0c1ca.web.app (expires Fri, 11 Jul 2025 00:54:57 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
dsuket
added a commit
to dsuket/docusaurus-openapi-docs
that referenced
this pull request
Oct 13, 2025
fix: change label change tab label name of anyOf/oneOf build feat: refactor request and response example fix: primitive add build fix: Added handling for when there is no schema. feat: Add new endpoints for allOf with nested array items and properties in OpenAPI schema [Enhancement] Add vendor extension support for positioning sidebar items (PaloAltoNetworks#1160) * Add support for x-position vendor extension and sorting logic * Add position and x-position types chore: restrict workflows to main repo (PaloAltoNetworks#1169) docs: fix typos and tables (PaloAltoNetworks#1170) Change the tab label of anyOf/oneOf (PaloAltoNetworks#1167) * feat: support null type * fix: fix tab label refactor: refactor request and response example (PaloAltoNetworks#1161) * feat: refactor request and response example * fix: primitive refactor: change ResponseSamples to CodeSamples (PaloAltoNetworks#1162)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 PR consists of added support for allowing users to add a
x-positionvendor extension for positioning sidebar items accordingly. Thex-position:numbercan be defined at the endpoint/method level and can be used for the following scenarios:x-positionwill be positioned in ascending order, followed by any other sidebar items in their original order.x-positionwill take precedence followed by other sidebar items in their original order.Motivation and Context.
See #1147 for context.
How Has This Been Tested?
Tested by defining a
x-positionfor the following Petstore methods:Screenshots (if appropriate)
Original sidebar item positions
Added x-position vendor extension
Types of changes
Checklist