Allow deprecation of input values #525

smitt04 · 2018-10-23T21:26:00Z

Started the @deprecated proposal in reference to #197

Please let me know if there is anything i missed or you would like changed. This was just a quick update to get the ball rolling again.

@IvanGoncharov Are you still interested in reviewing this?

facebook-github-bot · 2018-10-23T21:26:06Z

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

facebook-github-bot · 2018-10-23T21:39:28Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

spec/Section 4 -- Introspection.md

IvanGoncharov · 2018-10-24T13:14:38Z

spec/Section 3 -- Type System.md

@@ -1778,3 +1778,15 @@ type ExampleType {
  oldField: String @deprecated(reason: "Use `newField`.")
 }
 ```
+


I think you also need to expand above text:

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.

IvanGoncharov · 2018-10-24T13:18:02Z

spec/Section 4 -- Introspection.md

@@ -332,6 +334,8 @@ Fields
 * `name` must return a String.
 * `description` may return a String or {null}.
 * `inputFields`: a list of `InputValue`.
+  * Accepts the argument `includeDeprecated` which defaults to {false}. If
+    {true}, deprecated enum values are also returned.


Suggested change

{true}, deprecated enum values are also returned.

{true}, deprecated fields are also returned.

IvanGoncharov · 2018-10-24T13:19:19Z

spec/Section 4 -- Introspection.md

@@ -392,6 +396,9 @@ Fields
 * `defaultValue` may return a String encoding (using the GraphQL language) of the
  default value used by this input value in the condition a value is not
  provided at runtime. If this input value has no default value, returns {null}.
+* `isDeprecated` returns {true} if this field or argument should no longer be used,
+  otherwise {false}.
+* `deprecationReason` optionally provides a reason why this field or argument is deprecated.


Suggested change

* `deprecationReason` optionally provides a reason why this field or argument is deprecated.

* `deprecationReason` optionally provides a reason why this input field or argument is deprecated.

spec/Section 3 -- Type System.md

IvanGoncharov · 2018-10-24T13:40:10Z

@smitt04 Looks good so far, I left a few review feedbacks.
Next step would be to work on PR for graphql-js: https://github.com/graphql/graphql-js
Just create a draft PR and I will review it.

Also, we need to discuss it on WG, here is the next one:
https://github.com/graphql/graphql-wg/blob/master/agendas/2018-11-08.md
You can add yourself to attendees and a new item to agenda like this:
https://github.com/graphql/graphql-wg/pull/103/files

smitt04 · 2018-10-24T15:36:13Z

@IvanGoncharov I have update the PR with suggested fixes. I have also submitted a PR to graphql-wg.

I can start looking into graphql-js, although I haven't worked in javascript graphql for a couple years. I am mostly working with golang graphql as of late.

IvanGoncharov · 2018-10-24T16:40:38Z

I can start looking into graphql-js, although I haven't worked in javascript graphql for a couple years. I am mostly working with golang graphql as of late.

NP, you can just open an issue on graphql-js and I will try to implement it before WG.

tomasaschan · 2018-10-25T17:20:36Z

I just want to cheer you on and add my hopes that this will be merged and added soon. 🙌

It's quite a wonderful feeling to realize you're missing a feature, and when you start looking for discussions about it you find this (on graphql/graphql-js#1560):

Neitsch · 2019-01-06T04:17:16Z

Should we only allow the deprecated directive on nullable arguments? This can not be expressed in the directive definition, but logically that might make sense.

Anufant · 2019-02-20T12:01:21Z

@IvanGoncharov
Hi Ivan!
Could you tell me please, when this PR will be merged?
I want to deprecate some input arguments in my GQL schema very much :)

ghost · 2019-02-20T13:57:47Z

I'm also really looking forward to this feature!

IvanGoncharov · 2019-02-20T14:48:02Z

@Anufant We discussed it on the last WG and everyone agreed that this issue should be fast-tracked so it definitely going into next spec release. Not sure about the exact date since there are a few things we need to discuss and implement in graphql-js before merging this.
You can read about the necessary RFC stages here:
https://github.com/facebook/graphql/blob/master/CONTRIBUTING.md#rfc-contribution-champions

tjkirch · 2019-03-22T19:25:00Z

Awesome, glad this is moving! Does that mean the "Next Stage?" tag can be updated to a later stage? :)

dice14u · 2019-04-10T23:13:04Z

What is the next step here, it seems it has a champion with smitt04 having written both the propsal here and a (now stale) implementation in graphql-js "discussed it on the last WG and everyone agreed .. definitely going into next spec release" sounds like acceptance by WG so stage 3. Is there something a community member can do to get this merged in on the fast tracked path ?

vlad-accedo · 2020-12-04T02:24:14Z

wow

Co-authored-by: Ivan Goncharov <[email protected]>

smyrick · 2021-04-30T21:12:02Z

FYI for those tracking the issue, it has not officially merged into the spec yet, it has just moved to the next stage. See the actual changes here: #805

Co-authored-by: Ivan Goncharov <[email protected]>

facebook-github-bot added the CLA Signed label Oct 23, 2018

IvanGoncharov reviewed Oct 24, 2018

View reviewed changes

spec/Section 4 -- Introspection.md Show resolved Hide resolved

IvanGoncharov reviewed Oct 24, 2018

View reviewed changes

spec/Section 3 -- Type System.md Show resolved Hide resolved

IvanGoncharov added the 💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md) label Oct 24, 2018

IvanGoncharov mentioned this pull request Oct 24, 2018

Deprecation of input fields #197

Closed

IvanGoncharov added 💭 Strawman (RFC 0) RFC Stage 0 (See CONTRIBUTING.md) 🚀 Next Stage? This RFC believes it is ready for the next stage and removed 💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md) labels Oct 24, 2018

This was referenced Oct 24, 2018

Add deprecated directive to arguments and input values graphql/graphql-js#1560

Closed

@deprecated directive on input graph-gophers/graphql-go#204

Closed

Allow @deprecated directive on field args graph-gophers/graphql-go#243

Closed

tomasaschan mentioned this pull request Oct 25, 2018

Support deprecated directive on input fields apollographql/apollo-server#1881

Closed

1 task

kestred mentioned this pull request Oct 26, 2018

[Pre-RFC] Support gradual upgrade/rename of Input types and Scalars in field arguments for values with compatible wire format #526

Closed

tjkirch mentioned this pull request Mar 22, 2019

Add support for automatically translating Rust deprecations to GraphQL deprecations graphql-rust/juniper#250

Closed

IvanGoncharov mentioned this pull request Apr 10, 2019

Allow Deprecation of Optional Arguments #575

Closed

benjie mentioned this pull request Oct 2, 2020

[2020-07-02] Input Field @deprecated; talk to Shopify to determine SHOULD vs MUST graphql/graphql-wg#517

Closed

martinbonnin mentioned this pull request Oct 23, 2020

Add support for @deprecated directive without any deprecation reason apollographql/apollo-kotlin#2692

Merged

IvanGoncharov changed the base branch from master to deprecate-args December 3, 2020 16:42

IvanGoncharov changed the title ~~Add to the @deprecated directive to allow deprecation of inputValues~~ Allow deprecation of input values Dec 3, 2020

IvanGoncharov merged commit 41ca330 into graphql:deprecate-args Dec 3, 2020

IvanGoncharov mentioned this pull request Dec 3, 2020

Allow deprecation of input values (field args, directive args, input fields) #805

Merged

benjie mentioned this pull request Dec 4, 2020

[2020-07-02] Moving the @deprecated directive on Input Fields RFC to Stage 2 graphql/graphql-wg#507

Closed

grzegorzstachniukalm mentioned this pull request Dec 4, 2020

Allow deprecation of input fields webonyx/graphql-php#155

Closed

bryanburgers mentioned this pull request Jan 4, 2021

InputObject no longer supports deprecated fields async-graphql/async-graphql#374

Closed

enumag mentioned this pull request Jan 11, 2021

Allow deprecation of input values (arguments and input fields) webonyx/graphql-php#110

Closed

mrtnzlml mentioned this pull request Jan 27, 2021

Feature request: support for deprecating input values graphql-rust/juniper#864

Open

leebyron added 📄 Draft (RFC 2) RFC Stage 2 (See CONTRIBUTING.md) and removed 💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md) 🚀 Next Stage? This RFC believes it is ready for the next stage labels Feb 4, 2021

tiago-loureiro mentioned this pull request Feb 18, 2021

Is it possible to deprecate a union member? graphql-nexus/nexus#256

Closed

benjie mentioned this pull request Mar 7, 2021

[2021-02-04] Ensure @deprecated directive on Input Fields RFC can advance graphql/graphql-wg#639

Closed

leebyron added this to the May2021 milestone Apr 6, 2021

peldax mentioned this pull request Apr 8, 2021

Deprecation of input fields and arguments graphpql/graphpinator#149

Closed

leebyron mentioned this pull request Apr 22, 2021

Final editorial review of "Allow deprecation of input values #525" #837

Closed

leebyron pushed a commit that referenced this pull request Apr 22, 2021

Allow deprecation of input values (#525)

261df09

Co-authored-by: Ivan Goncharov <[email protected]>

danielnovograd mentioned this pull request Apr 30, 2021

Update prelude to match graphql_spec for @deprecated directive vektah/gqlparser#155

Merged

IvanGoncharov added a commit that referenced this pull request Jan 9, 2022

Allow deprecation of input values (#525)

0e1f9b8

Co-authored-by: Ivan Goncharov <[email protected]>

ruudk mentioned this pull request Feb 14, 2023

Allow deprecating arguments webonyx/graphql-php#1312

Closed

yanns mentioned this pull request Mar 30, 2023

support @deprecated on argument and input field sangria-graphql/sangria#982

Closed

This was referenced Apr 3, 2023

Directive for Input fields graphql-dotnet/graphql-dotnet#3570

Closed

Allow deprecation of input values graphql-dotnet/graphql-dotnet#3571

Merged

newhouse mentioned this pull request Jun 12, 2023

@deprecated fields in input type objects are not documented anvilco/spectaql#827

Closed

PlayAnyData mentioned this pull request Jul 29, 2024

Cannot deprecate GraphQL field in auto generated schema (code first) nestjs/nest#13060

Closed

15 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow deprecation of input values #525

Allow deprecation of input values #525

smitt04 commented Oct 23, 2018

facebook-github-bot commented Oct 23, 2018

facebook-github-bot commented Oct 23, 2018

IvanGoncharov Oct 24, 2018

IvanGoncharov Oct 24, 2018

IvanGoncharov Oct 24, 2018

IvanGoncharov commented Oct 24, 2018

smitt04 commented Oct 24, 2018

IvanGoncharov commented Oct 24, 2018

tomasaschan commented Oct 25, 2018

Neitsch commented Jan 6, 2019

Anufant commented Feb 20, 2019

ghost commented Feb 20, 2019

IvanGoncharov commented Feb 20, 2019

tjkirch commented Mar 22, 2019

dice14u commented Apr 10, 2019

vlad-accedo commented Dec 4, 2020

smyrick commented Apr 30, 2021

	{true}, deprecated enum values are also returned.
	{true}, deprecated fields are also returned.

	* `deprecationReason` optionally provides a reason why this field or argument is deprecated.
	* `deprecationReason` optionally provides a reason why this input field or argument is deprecated.

Allow deprecation of input values #525

Allow deprecation of input values #525

Conversation

smitt04 commented Oct 23, 2018

facebook-github-bot commented Oct 23, 2018

facebook-github-bot commented Oct 23, 2018

IvanGoncharov Oct 24, 2018

Choose a reason for hiding this comment

IvanGoncharov Oct 24, 2018

Choose a reason for hiding this comment

IvanGoncharov Oct 24, 2018

Choose a reason for hiding this comment

IvanGoncharov commented Oct 24, 2018

smitt04 commented Oct 24, 2018

IvanGoncharov commented Oct 24, 2018

tomasaschan commented Oct 25, 2018

Neitsch commented Jan 6, 2019

Anufant commented Feb 20, 2019

ghost commented Feb 20, 2019

IvanGoncharov commented Feb 20, 2019

tjkirch commented Mar 22, 2019

dice14u commented Apr 10, 2019

vlad-accedo commented Dec 4, 2020

smyrick commented Apr 30, 2021