# no-scalar-result-on-mutation

Source: https://api-genie.dev/docs/linter/graphql/rules/no-scalar-result-on-mutation

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

```graphql
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'`.

```graphql
type Mutation { logout: Boolean }
```
