# field-description-defined

Source: https://api-genie.dev/docs/linter/graphql/rules/field-description-defined

A rule of the GraphQL linter, which reads GraphQL schemas and operations. Since 0.9.0. In the rulesets: Strict at error, All at error.

This rule checks that the fields of object and interface types 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.

The rule applies to definitions. An `# apigenie-lint-disable field-description-defined` 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**.

```graphql
type User {
  "The identifier of the user."
  id: ID!
}
```

**Bad**. The linter reports `Field 'User.id' should have a description`.

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