known-types

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

This rule checks that the types referenced by type system definitions are built-in scalars or defined in the document, 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 reports references to types and fragments that are not in the document only when the configuration sets self_contained: true, since schemas and operations are often split across files.

The rule applies to definitions. An # apigenie-lint-disable known-types 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 Query { user: User }
type User { id: ID! }

Bad. The linter reports Unknown type "User"..

type Query { user: User }

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-types: off

Further reading

Was this helpful?