known-directive-locations

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

This rule checks that directives are used at one of the locations of their definition, 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 schemas and to operations. The built-in directives and those defined in the document are known; other directives are not checked.

The rule applies to definitions. An # apigenie-lint-disable known-directive-locations 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.

directive @auth on FIELD_DEFINITION
type Query { a: Int @auth }

Bad. The linter reports Directive "@auth" may not be used on OBJECT..

directive @auth on FIELD_DEFINITION
type Query @auth { a: Int }

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:
        known-directive-locations: off

Further reading

Last updated on View as Markdown
Was this helpful?