[OpenAPI] Add nullable property description - #3312
Closed
kayneth wants to merge 1 commit into
Closed
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
kayneth
marked this pull request as ready for review
December 18, 2019 13:22
soyuka
approved these changes
Dec 20, 2019
soyuka
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
lgtm, may you rebase?
Sorry, something went wrong.
Copy link
Copy Markdown
Author
|
Ok, done. Thank you |
Sorry, something went wrong.
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.
While trying to generate a client with Jane, I encountered a missing piece of OpenAPI 3.0 for nullable properties. It's useful in order to generate models with nullable getters.
As stated on src/JsonSchema/SchemaFactory.php:173: "externalDocs is an OpenAPI specific extension, but JSON Schema allows additional keys, so we always add it" for the property schema.
Then we could also add the nullable feature.
Another take, would be to considered each components schema non required properties as optional. Therefore, I should make a PR to Jane in order to use non-required properties instead of nullable properties to generate models. But this is not a desired behaviour on their side.