reserved-names

Since 0.9.0 · In the rulesets: Recommended at error, Strict at error, All at error

This rule checks that the names of types, fields, arguments, enum values and directives don’t start with “__”, as the GraphQL specification requires.

Rule details

The rule reports the issues of the validation rule of the same name, with the messages of graphql-js. A document that breaks it is rejected by GraphQL servers and tools, so the rule should stay enabled with the error severity.

The rule applies to definitions. An # apigenie-lint-disable reserved-names 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.

type User { id: ID! }

Bad. The linter reports Name "__id" must not begin with "__", which is reserved by GraphQL introspection..

type User { __id: ID! }

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:
        reserved-names: off

Further reading

Last updated on View as Markdown
Was this helpful?