fix: correct sort order for async API keys and update related tests#2741
Merged
DmitryAnansky merged 3 commits intoRedocly:mainfrom Apr 16, 2026
Merged
Conversation
🦋 Changeset detectedLatest commit: 5f7feb2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
leefreemanxyz
force-pushed
the
fix/correct-sort-order-for-async-api-keys
branch
2 times, most recently
from
ad87eec to
f12216b
Compare
leefreemanxyz
force-pushed
the
fix/correct-sort-order-for-async-api-keys
branch
from
f12216b to
4a5c91b
Compare
Co-authored-by: Dmytro Anansky <dmytro@redocly.com>
JLekawa
approved these changes
Apr 15, 2026
DmitryAnansky
approved these changes
Apr 15, 2026
Contributor
DmitryAnansky
left a comment
DmitryAnansky
left a comment
There was a problem hiding this comment.
@leefreemanxyz
Thank you for your contribution!
Contributor
|
Hi @leefreemanxyz |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What/Why/How?
This resolves #2740. AsyncApi definitions will now bundle with a regular order, including the
asyncapi: <version>appearing as the first line. This brings the behaviour for bundling for AsyncAPI in line with that of the OpenAPI bundling.Reference
???
Testing
I've added unit tests and fixed any broken ones.
Screenshots (optional)
Check yourself
Security
Note
Low Risk
Low risk: changes only affect deterministic output ordering during
bundle/join, with coverage via updated unit and e2e snapshot tests.Overview
Ensures bundled AsyncAPI documents have a consistent top-level key order (including
asyncapias the first key), bringing AsyncAPI output in line with existing OpenAPI key ordering.Replaces
sortTopLevelKeysForOaswith a generalizedsortTopLevelKeysthat supports OAS2/OAS3 plus AsyncAPI 2/3, updatesbundle/jointo use it, and adjusts/extends unit tests and AsyncAPI e2e snapshots accordingly.Reviewed by Cursor Bugbot for commit 5f7feb2. Bugbot is set up for automated code reviews on this repo. Configure here.