feat(entgql): Allow comments on edge fields #457
Merged
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.
If you add a comment to a field in the Ent schema, the comment will automatically carry over to the graphql schema. This behavior does not work on edges.
Of note, it may make sense to add a new
entgql.Comment("gql description here")
annotation that allows you to override the comment you have in your schema. The comment specified in the annotation would be used in the GraphQL schema; falling back to the comment added to the Field/Edge if the annotation was not provided. Thoughts?