[BUG][openapi-yaml] Preserve field order in auto-generated object-level examples (#23664)#23674
Open
swapneswarsundarray wants to merge 2 commits intoOpenAPITools:masterfrom
Open
Conversation
The openapi-yaml generator was using HashMap when building object-level examples from property examples, which caused unstable field ordering that didn't match the source spec declaration order. Switch to LinkedHashMap to preserve the order as defined in the OpenAPI spec. This improves readability in Swagger UI and other downstream tools that render the auto-generated examples. Add test to verify property order preservation.
Member
|
Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors. Let me know if you need help fixing it. |
…enAPITools#23664) The openapi-yaml generator was using HashMap when building object-level examples from property examples, which caused unstable field ordering that didn't match the source spec declaration order. Switch to LinkedHashMap to preserve the order as defined in the OpenAPI spec. This improves readability in Swagger UI and other downstream tools that render the auto-generated examples. Add test to verify property order preservation.
aa50335 to
ab188a8
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.
Fixes #23664
Problem
When the openapi-yaml generator constructs object-level examples from property-level examples, the resulting field order is unstable and does not match the property declaration order in the source specification.
Root Cause
The aggregated example is built using an unordered Map (HashMap), which does not preserve insertion order.
Solution
Use LinkedHashMap when constructing the example and iterate over schema properties in declaration order to ensure deterministic output.
Changes
Verification
Impact
Generated examples are now deterministic and aligned with the source specification. This improves readability and consistency in downstream tools such as Swagger UI.
Test
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Preserves property order in auto-generated object examples in
openapi-yaml, so outputs are deterministic and match the spec’s declaration order. This improves readability in Swagger UI and other tools.HashMapwithLinkedHashMapinExampleGeneratorto keep insertion order.Written for commit ab188a8. Summary will update on new commits.