Directives

deprecated#

Marks an element of a GraphQL schema as no longer supported.

directive @deprecated(
reason: String = "No longer supported"
)

Arguments#

NameDescription
reason (String) Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org.

include#

Directs the executor to include this field or fragment only when the if argument is true.

directive @include(
if: Boolean!
)

Arguments#

NameDescription
if (Boolean!) Included when true.

skip#

Directs the executor to skip this field or fragment when the if argument is true.

directive @skip(
if: Boolean!
)

Arguments#

NameDescription
if (Boolean!) Skipped when true.

specifiedBy#

Exposes a URL that specifies the behaviour of this scalar.

directive @specifiedBy(
url: String!
)

Arguments#

NameDescription
url (String!) The URL that specifies the behaviour of this scalar.