Require discriminator instance to be an object #206
Merged
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
Previously, all non-hash instances were valid when using `discriminator`, which I think is incorrect and confusing. There are a couple options: 1. Require instances to be objects when using `discriminator` 2. Fall back to regular `allOf`/`anyOf`/`oneOf` processing for non-object instances I went with option 1, because it seems safer and I don't know if it makes sense to ever allow non-object instances. `discriminator` depends on `propertyName`, which itself requires hash instances. Allowing `null` is still possible by wrapping the `discriminator` schema in another `oneOf` (like the test example: `nullable_union_schema`). The [OpenAPI specification][0] doesn't say anything about non-object instances directly, but it does say: > The expectation now is that a property with name petType MUST be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Which I think can be interpreted as requiring the response payload to be an object. Fixes: #204 Related: be45f04 [0]: https://github.com/oai/openapi-specification/blob/main/versions/3.1.0.md#discriminator-object
davishmcclurg
force-pushed
the
non-object-discriminator
branch
from
9684462 to
5f20eaa
Compare
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.
Previously, all non-hash instances were valid when using
discriminator, which I think is incorrect and confusing. There are a couple options:discriminatorallOf/anyOf/oneOfprocessing for non-object instancesI went with option 1, because it seems safer and I don't know if it makes sense to ever allow non-object instances.
discriminatordepends onpropertyName, which itself requires hash instances. Allowingnullis still possible by wrapping thediscriminatorschema in anotheroneOf(like the test example:nullable_union_schema).The OpenAPI specification doesn't say anything about non-object instances directly, but it does say:
Which I think can be interpreted as requiring the response payload to be an object.
Fixes: #204
Related: be45f04