Fix ambiguity about optional variables in non-null args #520
Conversation
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
"Allowing optional variables when default values exist" wasn't very clear about what elements of the example were being referred to as optional/required or non-nullable. This minor rewrite attempts to resolve that ambiguity Fixes #507
leebyron
added
✏️ Editorial
mjmahone
reviewed
Oct 2, 2018
spec/Section 5 -- Validation.md
Outdated
| @@ -1938,6 +1938,10 @@ A notable exception to typical variable type compatibility is allowing a | |||
| variable definition with a nullable type to be provided to a non-null location | |||
| as long as either that variable or that location provides a default value. | |||
|
|
|||
| In the example below, an optional variable is allowed to be used in an | |||
| non-null optional argument (`optionalBooleanArg`) because it provides a default | |||
There was a problem hiding this comment.
it is ambiguous (optional variable or non-null optional argument?) and further muddied with the naming optionalBooleanArg (how is an optional argument non-nullable?)
Proposal:
In the example below, an optional variable is allowed to be used in an
non-null optional argument (`booleanArgWithDefault`) because the
field argument provides a default value in the schema.
spec/Section 5 -- Validation.md
Outdated
| @@ -1946,7 +1950,11 @@ query booleanArgQueryWithDefault($booleanArg: Boolean) { | |||
| } | |||
| ``` | |||
|
|
|||
| In the example above, an optional variable is allowed to be used in an non-null argument which provides a default value. | |||
| In the example below, an optional variable (`$booleanArg`) provides a default | |||
| value (`true`) and can be used in a non-null requied argument. This behavior is | |||
mjmahone
approved these changes
Oct 2, 2018
IvanGoncharov
approved these changes
Oct 14, 2018
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.
"Allowing optional variables when default values exist" wasn't very clear about what elements of the example were being referred to as optional/required or non-nullable. This minor rewrite attempts to resolve that ambiguity
Fixes #507