Don't add 'object' type when generating sum schema with allOf/oneOf#49
Merged
Conversation
Contributor
Author
|
Friendly ping. Should I assign a reviewer on my own? |
Contributor
Author
|
Ping |
Collaborator
|
Hm, I went through OpenAPI 3.0 spec and it does not explicitly mention |
maksbotan
approved these changes
Nov 21, 2022
dhess
added a commit
to hackworthltd/primer
that referenced
this pull request
Feb 3, 2023
The `openapi3` package was apparently generating an invalid OpenAPI spec for schemas that use `oneOf` or `allOf`. This was fixed in v3.2.3, which we now use after the package bump in the previous commit. See: biocad/openapi3#49
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
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.
When generating schema for some sum types the
typefield is set asobject. But that seems to be incorrect. E.g.will have schema
{ "oneOf": [ { "enum": [ "Bar" ], "type": "string" }, { "maximum": 9223372036854775807, "minimum": -9223372036854775808, "type": "integer" } ], "type": "object" }However, encoding of the Foo is clearly not an object.
This also confuses SwaggerUI.
Schema is valid

But generated example is not

If one removes

typefield example becomes validUnrelated change, but looks like there was a redundant dependency on
networkpackage. Few types from it were imported, but neither used nor re-exported.