Deprecated directive #384
Merged
Deprecated directive #384
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
|
This is a follow-up to #376 cc @helfer, @OlegIlyenko |
leebyron
force-pushed
the
deprecated-directive
branch
from
847541f to
498f479
Compare
|
Example of use: schema {
query: Query
}
enum MyEnum {
VALUE
OLD_VALUE @deprecated
OTHER_VALUE @deprecated(reason: "Terrible reasons")
}
type Query {
field1: String @deprecated
field2: Int @deprecated(reason: "Because I said so")
enum: MyEnum
} |
| name: 'deprecated', | ||
| description: | ||
| 'Marks an element of a GraphQL schema as no longer supported.', | ||
| locations: [ |
There was a problem hiding this comment.
Do we intend to support more directive locations later?
There was a problem hiding this comment.
Possibly so. Right now these are the only two kinds of things in the schema which can be deprecated according to the spec.
|
Looks great! This will be a good example for building custom directives. |
This adds a new directive as part of the experimental schema language: ``` directive @deprecated(reason: String = "No longer supported") on FIELD_DEFINITION | ENUM_VALUE ``` It also adds support for this directive in the schemaPrinter and buildASTSchema. Additionally exports a new helper `specifiedDirectives` which is encoured to be used when addressing the collection of all directives defined by the spec. The `@deprecated` directive is optimistically added to this collection. While it's currently experimental, it will become part of the schema definition language RFC.
leebyron
force-pushed
the
deprecated-directive
branch
from
498f479 to
6796fad
Compare
sogko
added a commit
to sogko/graphql-js
that referenced
this pull request
Jun 1, 2016
* master: (26 commits) 0.6.0 Validation: improving overlapping fields quality (graphql#386) Validation: context.getFragmentSpreads now accepts selectionSet rather than fragment AST node Factor out more closure functions Factor out closure functions to normal functions Deprecated directive (graphql#384) RFC: Directive location: schema definition (graphql#382) RFC: Schema Language Directives (graphql#376) Export introspection in public API Export directive definitions. (graphql#381) BUG: Ensure building AST schema does not exclude @Skip and @include (graphql#380) documentation of schema constructor Revert "Remove all 'instanceof GraphQLSchema' checks" (graphql#377) remove all 'instanceof GraphQLSchema' checks (graphql#371) Error logging for new interface type semantics (graphql#350) Nit: Missing case in grammar for TypeSystemDefinition in comment Bug: printer can print non-parsable value Factor out suggestion quoting utility Minor refactoring Minor refactoring of error messages for unknown fields ...
This was referenced Jun 15, 2016
This was referenced Sep 23, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a new directive as part of the experimental schema language:
It also adds support for this directive in the schemaPrinter and buildASTSchema.
Additionally exports a new helper
specifiedDirectiveswhich is encoured to be used when addressing the collection of all directives defined by the spec. The@deprecateddirective is optimistically added to this collection. While it's currently experimental, it will become part of the schema definition language RFC.