Adds Enum Type Default Value Uses Inaccessible Value Rule #47
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
glen-84
suggested changes
Aug 8, 2024
|
|
||
| ValidateArgumentDefaultValues(): | ||
|
|
||
| - Let {arguments} be all arguments of fields and directives across all subgraphs |
There was a problem hiding this comment.
Suggested change
| - Let {arguments} be all arguments of fields and directives across all subgraphs | |
| - Let {arguments} be all arguments of fields and directives across all source schemas |
|
|
||
| ValidateInputFieldDefaultValues(): | ||
|
|
||
| - Let {inputFields} be all input fields of across all subgraphs |
There was a problem hiding this comment.
Suggested change
| - Let {inputFields} be all input fields of across all subgraphs | |
| - Let {inputFields} be all input fields across all source schemas |
| - For each {argument} in {arguments} | ||
| - If {IsExposed(argument)} is true and has a default value: | ||
| - Let {defaultValue} be the default value of {argument} | ||
| - If not ValidateDefaultValue(defaultValue) |
There was a problem hiding this comment.
Suggested change
| - If not ValidateDefaultValue(defaultValue) | |
| - If not {ValidateDefaultValue(defaultValue)} |
| - Let {type} be the type of {inputField} | ||
| - If {IsExposed(inputField)} is true and {inputField} has a default value: | ||
| - Let {defaultValue} be the default value of {inputField} | ||
| - if ValidateDefaultValue(defaultValue) is false |
There was a problem hiding this comment.
Suggested change
| - if ValidateDefaultValue(defaultValue) is false | |
| - If {ValidateDefaultValue(defaultValue)} is false |
| **Explanatory Text** | ||
|
|
||
| This rule ensures that inaccessible enum values are not exposed in the composed schema through default values. | ||
| Output field arguments, input fields and directive arguments must only use enum values as their default value that is not annotated with the `@inaccessible` directive. |
There was a problem hiding this comment.
Suggested change
| Output field arguments, input fields and directive arguments must only use enum values as their default value that is not annotated with the `@inaccessible` directive. | |
| Output field arguments, input fields, and directive arguments must only use enum values as their default value when not annotated with the `@inaccessible` directive. |
| Output field arguments, input fields and directive arguments must only use enum values as their default value that is not annotated with the `@inaccessible` directive. | ||
|
|
||
| In this example the `FOO` value in the `Enum1` enum is not marked with | ||
| `@inaccessible`, hence it doesn't violate the rule. |
There was a problem hiding this comment.
Suggested change
| `@inaccessible`, hence it doesn't violate the rule. | |
| `@inaccessible`, hence it does not violate the rule. |
| } | ||
| ``` | ||
|
|
||
| This following example violates this rule because the default value for the field |
There was a problem hiding this comment.
Suggested change
| This following example violates this rule because the default value for the field | |
| The following example violates this rule because the default value for the field |
| field: Enum1 = FOO | ||
| } | ||
|
|
||
| directive @directive1(arg: Enum1 = FOO) on FIELD_DEFINITION |
There was a problem hiding this comment.
Should this be removed or described? It's not part of the example description above, and also not in the "good" example.
(same in the next counter-example)
| BAR | ||
| } | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Missing description of counter-example.
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.
No description provided.