required-arguments-provided

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

This rule checks that the required arguments of fields and directives are given.

Rule details

Arguments that are non-null and without default value are required; the server rejects operations that omit them.

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 required-arguments-provided 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 User { user(id: 1) { id } }

Bad. The linter reports Field "user" argument "id" of type "ID!" is required, but it was not provided..

query User { user { 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:
        required-arguments-provided: off
Last updated on View as Markdown
Was this helpful?