Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add openapi3.Schema.PropertyKeys #1003

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

diamondburned
Copy link

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 invopop/yaml#13 is merged.

@diamondburned diamondburned force-pushed the ordmap branch 2 times, most recently from ac16396 to a5b8ae9 Compare August 12, 2024 09:24
@diamondburned diamondburned changed the title Add openapi3.Schema.OrderedPropertyKeys Add openapi3.Schema.PropertyKeys Aug 13, 2024
This commit adds the `PropertyKeys` property to the type
`openapi3.Schema` which contains the keys of the `Properties` map in the
order that they appear in the original YAML file. This is useful to
guarantee deterministic code generation.

This is done via a temporary fork of the YAML-to-JSON transformation library.
It will not be ready until invopop/yaml#13 is merged.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant