feat: better path sorting for openapi UIs #6583
Merged
Conversation
This file contains 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
mrossard
force-pushed
the
openapi-sort
branch
from
cda8468
to
06bb7a2
Compare
|
This probably should target 3.3, used 3.4 without thinking...sorry. |
soyuka
reviewed
Sep 5, 2024
mrossard
commented
Sep 5, 2024
soyuka
reviewed
Sep 6, 2024
|
Thanks! |
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.
I've noticed for a while that operations sorting as displayed by tools like swagger-ui or scalar could be confusing at first - they are sorted by path, but displayed by tags first.
This PR sorts them by tags, then by path. As a very small optimization (assuming there are more writes than reads) it also triggers the sorting only when the paths are actually used instead of sorting each time a new path is added.