Skip to main content

deprecated

The @deprecated directive is used within the type system definition language to indicate deprecated portions of a GraphQL service’s schema,such as deprecated fields on a type or deprecated enum values.

directive @deprecated(
reason: String = "No longer supported"
) on
| FIELD_DEFINITION
| ARGUMENT_DEFINITION
| ENUM_VALUE
| INPUT_FIELD_DEFINITION
| DIRECTIVE_DEFINITION

Arguments​

deprecated.reason ● String scalar​

Deprecations include a reason for why it is deprecated, which is formatted using Markdown syntax (as specified by CommonMark).