At a glance
- Identifier: #892
- Stage: RFC X / Superseded
- Champion: @IvanGoncharov
- Latest activity: Spec PR closed on 2025-06-26
- Spec PR: https://github.com/graphql/graphql-spec/pull/892
Spec PR description
Was already discussed during WG: https://github.com/graphql/graphql-wg/blob/main/notes/2021-04-01.md#adding-descriptions-to-queries-and-fragments-ivan
I prepare a format proposal, here is a couple of key points:
- You can add descriptions on operations, fragments, and query variables
- You can't add description on the short form of operation only full form.
Example:
"Some description"
query SomeOperation(
"ID you should provide"
$id: String
"Switch for experiment ...."
$enableBaz: Boolean = false,
) {
foo(id: $id) {
bar
baz @include(if: $enableBaz) {
...BazInfo
}
}
}
"Some description here"
fragment BazInfo on Baz {
# ...
}
Timeline
June 2025
- Spec PR closed on 2025-06-26
- Marked as Superseded on 2025-06-26 by benjie
- Added to WG agenda on 2025-06-05
May 2025
- Advanced to RFC 2 on 2025-05-15 by leebyron
- Added to WG agenda on 2025-05-15
October 2021
- Top comment edited on 2021-10-07 by IvanGoncharov
- Spec PR created on 2021-10-07 by IvanGoncharov
- @IvanGoncharov committed "Add descriptions to executable definitions" on 2021-10-07
- Advanced to RFC 1 on 2021-10-07 by leebyron
- Added to WG agenda on 2021-10-07
- Mentioned in WG notes on 2021-10-07