Skip to main content
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.

•[__InputValue!]!
non-null
•String
•[__DirectiveLocation!]!
non-null
•String!
non-null

Deprecated fields

•Boolean!
non-nullDeprecated
•Boolean!
non-nullDeprecated
•Boolean!
non-nullDeprecated

Was this section helpful?