one-field-subscriptions

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

This rule checks that subscriptions select a single root field, as the specification requires.

Rule details

A subscription maps one event stream to responses; selecting several root fields, or an introspection field, is invalid. Inline fragments and the fragments of the document are followed.

The rule applies to operations and fragments. An # apigenie-lint-disable one-field-subscriptions 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.

subscription OnMessage { messageAdded { id } }

Bad. The linter reports Subscription "OnEvents" must select only one top level field..

subscription OnEvents { messageAdded { id } userJoined { id } }

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:
        one-field-subscriptions: off

Further reading

Was this helpful?