description-style

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

This rule checks that descriptions are written as block strings, or as single-line strings.

Rule details

One style of descriptions makes a schema easier to read and to diff. Block strings ("""...""") are the default, as they allow descriptions to grow over several lines.

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

Configuration

The configuration block can be a string, block or inline, or an object with the style property.

version: "1.0"
commands:
  lint:
    graphql:
      rules:
        description-style: [error, inline]

Examples

Good.

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

Bad. The linter reports The description of object type 'User' should be a block string ("""...""").

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

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:
        description-style: off
Last updated on View as Markdown
Was this helpful?