no-scalar-result-on-mutation

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

This rule checks that mutation fields return object types rather than scalars.

Rule details

A payload object can grow, e.g. with the changed objects or with errors, while a scalar result can only be replaced by a breaking change.

The rule applies to definitions. An # apigenie-lint-disable no-scalar-result-on-mutation 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.

type Mutation { logout: LogoutPayload }
type LogoutPayload { success: Boolean }

Bad. The linter reports Field 'Mutation.logout' should return an object type rather than the scalar 'Boolean'.

type Mutation { logout: Boolean }

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:
        no-scalar-result-on-mutation: off

Related rules

Last updated on View as Markdown
Was this helpful?