-
Notifications
You must be signed in to change notification settings - Fork 1.2k
add initial outline for field extensions #1196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for graphql-spec-draft ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for looking into this! Few comments below
- extend field MemberCoordinate Directives[const]? | ||
- extend field description MemberCoordinate |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
- extend field MemberCoordinate Directives[const]? | |
- extend field description MemberCoordinate | |
- extend field MemberCoordinate Directives[Const] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
- extend field MemberCoordinate Directives[const]? | |
- extend field description MemberCoordinate | |
- extend field MemberCoordinate Directives[Const] | |
- extend field Description MemberCoordinate |
https://github.com/graphql/graphql-wg/blob/main/rfcs/FieldExtensions.md
#1162