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.

Sign up for GitHub

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

Jump to bottom

Add openapi3.Schema.PropertyKeys #1003

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

Add openapi3.Schema.PropertyKeys #1003

wants to merge 2 commits into 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 mentioned this pull request Aug 12, 2024
Closed
@diamondburned diamondburned mentioned this pull request Aug 13, 2024
Draft
@diamondburned diamondburned changed the title Add openapi3.Schema.OrderedPropertyKeys Add openapi3.Schema.PropertyKeys Aug 13, 2024
@diamondburned
Add openapi3.Schema.PropertyKeys for deterministic order
1835b93 
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.
@diamondburned
Regenerate documentation
3b32458
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@diamondburned