Make array types in API nullable #166
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
ghost
self-requested a review
as a 
akpsgit
approved these changes
Mar 22, 2023
This change makes array types in the OAS nullable, without it when you
create an API request object during a PATCH like:
{
"Licenses": null
}
the API returns an error that the value is not nullable. We may also
want to do this for the other fields too.
We may want to revisit this when we revisit all the schemas for
GET/POST/PATCH because often null isn't a valid setting for some of
these arrays and it would be better to have a default of an empty list.
This pull request was closed.
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.
Description
This change makes array types in the OAS nullable, without it when you create an API request object during a PATCH like:
{
"Licenses": null
}
the API returns an error that the value is not nullable. We may also want to do this for the other fields too.
We may want to revisit this when we revisit all the schemas for GET/POST/PATCH because often null isn't a valid setting for some of these arrays and it would be better to have a default of an empty list.
Type of Change
[X] Bug Fix
[ ] New Feature
[ ] Breaking Change
[ ] Refactor
[ ] Documentation
[ ] Other (please describe)
Checklist