API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

deprecated

Version unstable

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"

Version 2021-07 (Release candidate)

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"

Version 2021-04 (Latest)

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"

Version 2021-01

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"

Version 2020-10

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"

Version 2020-07

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"

Version 2020-04

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"

Version 2020-01 (Unsupported)

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"

Version 2019-10 (Unsupported)

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"

Version 2019-07 (Unsupported)

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"

Version 2019-04 (Unsupported)

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

Locations

  • FIELD_DEFINITION
  • ENUM_VALUE
  • ARGUMENT_DEFINITION
  • INPUT_FIELD_DEFINITION

Arguments

Argument Description
reason ( String )

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in Markdown.
Default value: "No longer supported"