add initial outline for field extensions #1196

egoodwinx · 2025-10-08T02:20:09Z

https://github.com/graphql/graphql-wg/blob/main/rfcs/FieldExtensions.md
#1162

linux-foundation-easycla · 2025-10-08T02:20:13Z

The committers listed above are authorized under a signed CLA.

✅ login: egoodwinx / name: Emily Goodwin (8275f38)

netlify · 2025-10-08T02:20:14Z

✅ Deploy Preview for graphql-spec-draft ready!

Name	Link
🔨 Latest commit	`8275f38`
🔍 Latest deploy log	https://app.netlify.com/projects/graphql-spec-draft/deploys/6930f8dfe9887b0008266c03
😎 Deploy Preview	https://deploy-preview-1196--graphql-spec-draft.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

martinbonnin

Thanks for looking into this! Few comments below

spec/Appendix C -- Grammar Summary.md

spec/Section 3 -- Type System.md

BoD · 2025-10-09T09:26:04Z

spec/Appendix C -- Grammar Summary.md

+- extend field MemberCoordinate Directives[const]?
+- extend field description MemberCoordinate


Was the intent to have the ability to add a description to fields? The other extensions don't allow that. What happens if the field already has a description? I suggest we only allow adding directives:

Suggested change

- extend field MemberCoordinate Directives[const]?

- extend field description MemberCoordinate

- extend field MemberCoordinate Directives[Const]

This was suggested by @benjie on Discord. I think it makes sense, especially in an AI age where descriptions give valuable info to LLMs. But true it needs validation rules.

Thanks for the heads up 👍.

Interesting! Although I would find it a bit odd to allow adding descriptions on fields but not on types and more (maybe this should go to a different PR that does that more broadly and keep this one focused on directives).

If we do want to keep this I think the grammar should look like:

Suggested change

- extend field MemberCoordinate Directives[const]?

- extend field description MemberCoordinate

- extend field MemberCoordinate Directives[Const]

- extend field Description MemberCoordinate

I'd be happy extending extend type to allow a prefixed description. The rule would be if it already has a description it would be invalid, just like adding the same interface twice.

Option 1:

"Description" extend type MyType

Option 2:

extend type "Description" MyType

To me, the former is preferred over the latter, even though both are suboptimal.

There's also option 3:

extend "Description" type MyType

Or, and this may be the best option, option 4:

describe type MyType "Description" describe field MyType.field "Description" describe argument MyType.field(arg:) "Description" describe enum MyEnum "Description" describe enumValue MyEnum.VALUE "Description" describe directive @foo "Description" describe argument @foo(arg:) "Description"

Would mean the description is separate from the rest of the extension, but I think this is fine.

Thanks for highlighting this @BoD

benjie

A little editorial

benjie · 2025-12-04T15:51:32Z

spec/Appendix C -- Grammar Summary.md

+FieldExtension :
+
+- extend field MemberCoordinate Directives[Const]
+- extend field Description MemberCoordinate


Description is contentious, let's remove it for now.

Suggested change

- extend field Description MemberCoordinate

benjie · 2025-12-04T15:51:42Z

spec/Section 3 -- Type System.md

+FieldExtension :
+
+- extend field MemberCoordinate Directives[Const]
+- extend field Description MemberCoordinate


Suggested change

- extend field Description MemberCoordinate

benjie · 2025-12-04T15:52:57Z

spec/Section 3 -- Type System.md

+- extend field Description MemberCoordinate
+
+Field extensions are used to represent a field which has been extended from some
+previously defined field. For example this may be a GraphQL service which is


Suggested change

previously defined field. For example this may be a GraphQL service which is

previously defined field. For example this may be used by a GraphQL service which is

benjie · 2025-12-04T15:53:22Z

spec/Section 3 -- Type System.md

+In this example, we can deprecate the id field on the User type.
+
+```graphql example
+extend field User.name @deprecated(”Some reason”)


Beware of typographic quotes!

Suggested change

extend field User.name @deprecated(”Some reason”)

extend field User.name @deprecated(reason: "Some reason")

benjie · 2025-12-04T15:54:47Z

spec/Section 3 -- Type System.md

+extend field User.name @deprecated(”Some reason”)
+```
+
+** Field Validation **


The "Type" here relates to "type" as in "type-system" rather than type as in "object type".

Suggested change

** Field Validation **

**Type Validation**

benjie · 2025-12-04T15:54:58Z

spec/Section 3 -- Type System.md

+
+** Field Validation **
+
+Field validation have the potential to be invalid if incorrectly defined.


Suggested change

Field validation have the potential to be invalid if incorrectly defined.

Fields have the potential to be invalid if incorrectly defined.

benjie · 2025-12-04T15:55:17Z

spec/Section 3 -- Type System.md

+1. MemberCoordinate must be resolved to an existing field on a object or
+   interface type.


Suggested change

1. MemberCoordinate must be resolved to an existing field on a object or

interface type.

1. MemberCoordinate must resolve to an existing field on a object or

interface type.

add initial outline for field extensions

10cbf4b

martinbonnin reviewed Oct 8, 2025

View reviewed changes

address pr comments

b14e553

BoD reviewed Oct 9, 2025

View reviewed changes

egoodwinx and others added 2 commits October 9, 2025 18:02

minor formatting changes

20e079f

Merge branch 'main' into field-extension

8275f38

benjie requested changes Dec 4, 2025

View reviewed changes

		- extend field MemberCoordinate Directives[const]?
		- extend field description MemberCoordinate

	previously defined field. For example this may be a GraphQL service which is
	previously defined field. For example this may be used by a GraphQL service which is

	extend field User.name @deprecated(”Some reason”)
	extend field User.name @deprecated(reason: "Some reason")


		Field Validation

		Field validation have the potential to be invalid if incorrectly defined.

	Field validation have the potential to be invalid if incorrectly defined.
	Fields have the potential to be invalid if incorrectly defined.

		1. MemberCoordinate must be resolved to an existing field on a object or
		interface type.

add initial outline for field extensions #1196

Are you sure you want to change the base?

add initial outline for field extensions #1196

Conversation

egoodwinx commented Oct 8, 2025

Uh oh!

linux-foundation-easycla bot commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for graphql-spec-draft ready!

Uh oh!

martinbonnin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BoD Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

benjie left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

linux-foundation-easycla bot commented Oct 8, 2025 •

edited

Loading

netlify bot commented Oct 8, 2025 •

edited

Loading

BoD Oct 9, 2025 •

edited

Loading