no-root-type
Since 0.9.0 · In the rulesets: All at error
This rule checks that the schema doesn’t have the root operation types the configuration disallows.
Rule details
Some APIs are read-only, or don’t support subscriptions. The rule reports the disallowed root operation types; with the default configuration it reports nothing.
The rule applies to definitions. An # apigenie-lint-disable no-root-type 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 disallow property: a list of mutation
and subscription.
version: "1.0"
commands:
lint:
graphql:
rules:
no-root-type: [error, { disallow: [mutation, subscription] }]
Examples
Good.
type Query { me: User }
Bad. With the options { disallow: [mutation] }, the linter reports The schema should not have a mutation root operation type ('Mutation').
type Query { me: User }
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-root-type: off