operation-name-suffix

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

This rule checks that operation and fragment names don’t end with a redundant suffix.

Rule details

The keyword already gives the kind of a definition: query GetUserQuery repeats it. The default suffixes are Query, Mutation, Subscription and Fragment.

The rule applies to operations and fragments. An # apigenie-lint-disable operation-name-suffix 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 is an object with the suffixes property, the list of suffixes that are reported.

version: "1.0"
commands:
  lint:
    graphql:
      rules:
        operation-name-suffix: [error, { suffixes: [Query, Mutation] }]

Examples

Good.

query GetUser { me { id } }

Bad. The linter reports Operation 'GetUserQuery' should not end with 'Query'.

query GetUserQuery { me { 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:
        operation-name-suffix: off
Was this helpful?