fix: correct sort order for async API keys and update related tests#2741
Open
leefreemanxyz wants to merge 2 commits intoRedocly:mainfrom
Open
fix: correct sort order for async API keys and update related tests#2741leefreemanxyz wants to merge 2 commits intoRedocly:mainfrom
leefreemanxyz wants to merge 2 commits intoRedocly:mainfrom
Conversation
🦋 Changeset detectedLatest commit: f12216b 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 |
61fedb3 to
ad87eec
Compare
ad87eec to
f12216b
Compare
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
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 when bundling/joining specs, with coverage via updated unit/e2e snapshots.
Overview
AsyncAPI bundling output is now normalized to a stable top-level key order (ensuring
asyncapiappears first), bringing it in line with existing OpenAPI key ordering.This replaces
sortTopLevelKeysForOaswith a generalizedsortTopLevelKeysthat supports OAS2/OAS3 plus AsyncAPI 2/3, updatesbundle/jointo use it, and adjusts unit tests and AsyncAPI e2e snapshots accordingly. A patch changeset is included for@redocly/cli.Reviewed by Cursor Bugbot for commit f12216b. Bugbot is set up for automated code reviews on this repo. Configure here.