Linter rulesGraphQLinterface-implementation

interface-implementation

Since 0.9.0

This rule checks that object and interface types implement their interfaces with all their fields, compatible field types and matching arguments, as the GraphQL specification requires.

Rule Details

The rule reports the issues of the validation rule of the same name, with the messages of graphql-js. A document that breaks it is rejected by GraphQL servers and tools, so the rule should stay enabled with the error severity.

Configuration

This rule has no options.

version: "1.0"
commands:
  lint:
    graphql:
      rules:
        interface-implementation: warning

The rule can be disabled for a node and everything nested in it with an # apigenie-lint-disable interface-implementation 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 definitions.

Examples

Good.

interface Node { id: ID! }
type User implements Node { id: ID! }

Bad. The linter reports Interface field Node.id expected but User does not provide it..

interface Node { id: ID! }
type User implements Node { name: String }

Further reading