Use required
on input, nullable
on output to determine GraphQL nullability
#3
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.
In GraphQL, fields are either wrapped in a
GraphQLNonNull
(type ends with!
) or not. In input types, a field withGraphQLNonNull
type must be present and must not benull
In output types, a field withGraphQLNonNull
type cannot return anull
valueThe OpenAPI spec is not clear on the meaning of "required" but the JSON schema specification that OpenAPI 3.0 uses is clearer
The OpenAPI spec also provides a "nullable" property
In OpenAPI, the same component schema can be used as both input and output types. So we must interpret "required" and "nullable" differently. For input types, we must interpret "required" as
GraphQLNonNull
and ignore "nullable" (sinceGraphQLNonNull
implies non-nullable). For output types, we must interpret "nullable" asGraphQLNonNull
and ignore "required" (since presence in output is determined by the query).