Preserve map ordering when transforming #1
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
This was referenced Aug 12, 2024
This commit changes both JSONToYAML and YAMLToJSON to preserve the map key ordering when the document is transformed. This is done by reimplementing the library to use YAML v3's yaml.Node API.
diamondburned
force-pushed
the
upgrade-yaml-v3
branch
from
edc2747
to
baf990d
Compare
diamondburned
pushed a commit
to diamondburned/kin-openapi
that referenced
this pull request
Aug 12, 2024
This commit adds the `OrderedPropertyKeys` method to the
`openapi3.Schema`:
OrderedPropertyKeys returns the keys of the properties in the order
they were defined. This is useful for generating code that needs to
iterate over the properties in a consistent order. If the keys could
not be extracted for some reason, then this method automatically
sorts the keys to be deterministic.
This is done via a temporary fork of the YAML-to-JSON transformation library.
It will not be ready until these PRs are merged in this order:
- silasdavis/yaml#1
- ghodss/yaml#62
diamondburned
added a commit
to diamondburned/kin-openapi
that referenced
this pull request
Aug 12, 2024
This commit adds the `OrderedPropertyKeys` method to the
`openapi3.Schema`:
OrderedPropertyKeys returns the keys of the properties in the order
they were defined. This is useful for generating code that needs to
iterate over the properties in a consistent order. If the keys could
not be extracted for some reason, then this method automatically
sorts the keys to be deterministic.
This is done via a temporary fork of the YAML-to-JSON transformation library.
It will not be ready until these PRs are merged in this order:
- silasdavis/yaml#1
- ghodss/yaml#62
3 tasks
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.
This commit changes both JSONToYAML and YAMLToJSON to preserve the map key ordering when the document is transformed. This is done by reimplementing the library to use YAML v3's yaml.Node API.