Add support for descriptions on executable documents (GraphQL September 2025) #1008
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.
Summary
Implements support for descriptions on executable documents as specified in the GraphQL September 2025 spec.
This feature allows descriptions (documentation strings) to be added to:
Implements graphql/graphql-spec#1170
Reference implementation: graphql/graphql-js#4430
Motivation
Descriptions are a core feature of GraphQL for documenting schemas. This extends that capability to executable documents, enabling:
Descriptions remain non-semantic - they do not affect execution, validation, or response behavior.
Example Usage
Changes
graphql.ungram
to add optionalDescription
to executable definitionscargo xtask codegen
No breaking changes. This is a purely additive feature:
Tests