enum-value-description-defined
Since 0.9.0 · In the rulesets: Strict at error, All at error
This rule checks that enum values have a description.
Rule details
Descriptions are part of the schema: introspection serves them to GraphiQL, IDEs, documentation generators and code generators. A missing or blank description is reported; type extensions have no descriptions and are not checked.
The rule applies to definitions. An # apigenie-lint-disable enum-value-description-defined comment
on a node turns it off for the node and everything nested in it; at the top of the file, separated
from the first definition by a blank line, the comment turns it off for the whole file.
Examples
Good.
enum Kind {
"A cat."
CAT
}
Bad. The linter reports Enum value 'Kind.CAT' should have a description.
enum Kind { CAT }
Turn it off or change its severity
In apigenie.yaml, off turns the rule off and warning or error sets its severity; a rule with options takes the severity and the options as a pair, [warning, options]. lint.graphql has the details.
commands:
lint:
graphql:
rules:
enum-value-description-defined: off