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

Switch YAML parser to ruamel.yaml which uses YAML 1.2 #1042

Merged
merged 9 commits into from
May 18, 2024

Conversation

rtaycher
Copy link
Contributor

fixes #1041
ruamel.yaml understands yaml1.2 which yaml doesn't support.
yaml 1.2 lacks norway issue

@dbanty dbanty changed the title fix: switch YAML parser to fix yaml 1.1 parsing issues Switch YAML parser to ruamel.yaml which uses YAML 1.2 May 18, 2024
Copy link
Collaborator

@dbanty dbanty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update! From what I could tell, ruamel.yaml.string is only used for tests, so I moved it to a dev dependency. If that's wrong, though, please let me know!

@dbanty dbanty added this pull request to the merge queue May 18, 2024
Merged via the queue into openapi-generators:main with commit a97dad1 May 18, 2024
20 checks passed
dbanty added a commit that referenced this pull request May 18, 2024
This PR was created by Knope. Merging it will create a new release

### Breaking Changes

#### `const` values in responses are now validated at runtime

Prior to this version, `const` values returned from servers were assumed
to always be correct. Now, if a server returns
an unexpected value, the client will raise a `ValueError`. This should
enable better usage with `oneOf`.

PR #1024. Thanks @peter-greenatlas!

#### Switch YAML parsing to 1.2

This change switches the YAML parsing library to `ruamel.yaml` which
follows the YAML 1.2 specification.
[There are breaking
changes](https://yaml.readthedocs.io/en/latest/pyyaml/#defaulting-to-yaml-12-support)
from YAML 1.1 to 1.2,
though they will not affect most use cases.

PR #1042 fixes #1041. Thanks @rtaycher!

### Features

- allow Ruff 0.4 (#1031)

### Fixes

#### Fix nullable and required properties in multipart bodies

Fixes #926.

> [!WARNING]
> This change is likely to break custom templates. Multipart body
handling has been completely split from JSON bodies.

Co-authored-by: GitHub <github-actions@github.com>
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.

Use ruamel.yaml instead of pyyaml to avoid the "NO"rway problem
2 participants