diff --git a/src/index.js b/src/index.js index d5e6b5fe5a..943d101068 100644 --- a/src/index.js +++ b/src/index.js @@ -330,7 +330,8 @@ export { buildASTSchema, // Build a GraphQLSchema from a GraphQL schema language document. buildSchema, - // Get the description from a schema AST node. + // @deprecated: Get the description from a schema AST node and supports legacy + // syntax for specifying descriptions - will be removed in v16 getDescription, // Extends an existing GraphQLSchema from a parsed GraphQL Schema // language AST. diff --git a/src/type/schema.js b/src/type/schema.js index 70432a8504..f2d0ee0d29 100644 --- a/src/type/schema.js +++ b/src/type/schema.js @@ -252,8 +252,7 @@ export type GraphQLSchemaValidationOptions = {| * in this list valid, even if they do not adhere to the specification's * schema validation rules. * - * This option is provided to ease adoption and may be removed in a future - * major release. + * This option is provided to ease adoption and will be removed in v15. */ allowedLegacyNames?: ?$ReadOnlyArray, |}; diff --git a/src/utilities/buildASTSchema.js b/src/utilities/buildASTSchema.js index 85f85ac5cf..7ab715790c 100644 --- a/src/utilities/buildASTSchema.js +++ b/src/utilities/buildASTSchema.js @@ -85,6 +85,7 @@ export type BuildSchemaOptions = { * Descriptions are defined as preceding string literals, however an older * experimental version of the SDL supported preceding comments as * descriptions. Set to true to enable this deprecated behavior. + * This option is provided to ease adoption and will be removed in v16. * * Default: false */ @@ -471,6 +472,7 @@ function getDeprecationReason( /** * Given an ast node, returns its string description. + * @deprecated: provided to ease adoption and will be removed in v16. * * Accepts options as a second argument: * diff --git a/src/utilities/index.js b/src/utilities/index.js index 39f956803c..cf14c719c0 100644 --- a/src/utilities/index.js +++ b/src/utilities/index.js @@ -51,7 +51,13 @@ export { introspectionFromSchema } from './introspectionFromSchema'; export { buildClientSchema } from './buildClientSchema'; // Build a GraphQLSchema from GraphQL Schema language. -export { buildASTSchema, buildSchema, getDescription } from './buildASTSchema'; +export { + buildASTSchema, + buildSchema, + // @deprecated: Get the description from a schema AST node and supports legacy + // syntax for specifying descriptions - will be removed in v16 + getDescription, +} from './buildASTSchema'; export type { BuildSchemaOptions } from './buildASTSchema'; // Extends an existing GraphQLSchema from a parsed GraphQL Schema language AST.