fields-on-correct-type

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

This rule checks that the fields selected by operations are defined by their parent types.

Rule details

A field that its type doesn’t define is rejected by the server. __typename, and __schema and __type on the query root type, are allowed.

The rule checks operations against the schema files named by the schema property of the configuration, or against the type system of their own document. It reports nothing without a schema.

The rule applies to operations and fragments. An # apigenie-lint-disable fields-on-correct-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.

Examples

Good.

query Me { me { id name } }

Bad. The linter reports Cannot query field "nmae" on type "User"..

query Me { me { id nmae } }

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:
        fields-on-correct-type: off
Was this helpful?