Skip to content
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

Add user-definable description property to fields #1385

Open
Tracked by #1911
AndrewSisley opened this issue Apr 21, 2023 · 0 comments
Open
Tracked by #1911

Add user-definable description property to fields #1385

AndrewSisley opened this issue Apr 21, 2023 · 0 comments
Labels
area/query Related to the query component area/schema Related to the schema system feature New feature or request

Comments

@AndrewSisley
Copy link
Contributor

AndrewSisley commented Apr 21, 2023

Add user-definable description property to fields (client.FieldDescription, GQL SDL, JsonPatch), and display the field-level description via the GQL type system (e.g. on the query-fields).

GQL Descriptions in an SDL is defined in the spec: https://spec.graphql.org/October2021/#sec-Descriptions

Note: graphql-go does not support parsing of comments/descriptions from the SDL: graphql-go/graphql#116

Adding them via PatchCollection should be pretty trivial, we can always do that first, then figure out the SDL problem later. We could as a temporary workaround have a @description directive.

Related to: #1386

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/query Related to the query component area/schema Related to the schema system feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant