fields-on-correct-type

Since 0.9.0

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.

Configuration

This rule has no options.

version: "1.0"
commands:
  lint:
    graphql:
      rules:
        fields-on-correct-type: warning

The rule can be disabled for a node and everything nested in it with an # apigenie-lint-disable fields-on-correct-type comment on the node, or for a whole file with the comment at the top of the file, separated from the first definition by a blank line. It applies to operations and fragments.

Examples

Good.

query Me { me { id name } }

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

query Me { me { id nmae } }

Compatibility

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.