Choose a version:

__Directive

object

A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.

Anchor to FieldsFields

Anchor to argsargs • [__InputValue!]!non-null
Anchor to descriptiondescription • String
Anchor to isRepeatableisRepeatable • Boolean
Anchor to locationslocations • [__DirectiveLocation!]!non-null
Anchor to namename • String!non-null

Deprecated fields

Anchor to onFieldonField • Boolean!non-null
Anchor to onFragmentonFragment • Boolean!non-null
Anchor to onOperationonOperation • Boolean!non-null

Was this section helpful?