Linter rulesGraphQLtype-description-defined

type-description-defined

Since 0.9.0

This rule checks that type definitions 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.

Configuration

This rule has no options.

version: "1.0"
commands:
  lint:
    graphql:
      rules:
        type-description-defined: warning

The rule can be disabled for a node and everything nested in it with an # apigenie-lint-disable type-description-defined comment on the node, or for a whole file with the comment at the top of the file, separated from the first definition by a blank line. It applies to definitions.

Examples

Good.

"A user of the shop."
type User { id: ID! }

Bad. The linter reports Object type 'User' should have a description.

type User { id: ID! }

Related rules