validate value of 'const' properties (helps with discriminated unions) #1024
Conversation
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
For 'const' properties, the parsed value will now be checked against the value in the schema at runtime and a ValueError will be raised if they do not match. This helps with parsing `oneOf` when matching a const property is the only way to resolve which of the types should be returned.
|
I think this aligns with the rest of the project. For example, if a string that's supposed to be of format |
dbanty
approved these changes
Apr 19, 2024
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>
micha91
pushed a commit
to micha91/openapi-python-client
that referenced
this pull request
May 13, 2025
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 openapi-generators#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 openapi-generators#1042 fixes openapi-generators#1041. Thanks @rtaycher! ### Features - allow Ruff 0.4 (openapi-generators#1031) ### Fixes #### Fix nullable and required properties in multipart bodies Fixes openapi-generators#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
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.
For 'const' properties, the parsed value will now be checked against the value in the schema at runtime and a ValueError will be raised if they do not match. Until now, the values would just be
castto aLiteralwithout checking.This helps with with parsing
oneOfwhen matching a const property is the only way to resolve which of the types should be returned. i.e. if aoneOfcontains two schemas, but the properties in one are a subset of the other, then the only way to know which one to return is to validate theconstvalue.I know that for the most part this library parses but doesn't validate, but I don't see a way around it in this case. The spec itself mentions validation when talking about
oneOf:Note that this also addresses some of the use cases for discriminated unions. Per the spec, the
a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema.so implementing discriminators would be a speedup but with this change we'll at least construct the correct type.I'm happy to take any feedback, or abandon this if you don't like fact that it is validation. I originally went to try to implement discriminated unions fully, but this seemed like a much easier step towards that that gets the same result.