# type-description-defined

Source: https://apigenie.pl/docs/linter/graphql/rules/type-description-defined

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.

```yaml
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**.

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

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

```graphql
type User { id: ID! }
```