Skip to main content

Add descriptions to executable definitions

At a glance


Was already discussed during WG:

I prepare a format proposal, here is a couple of key points:

  1. You can add descriptions on operations, fragments, and query variables
  2. You can't add description on the short form of operation only full form.


"Some description"
query SomeOperation(
"ID you should provide"
$id: String

"Switch for experiment ...."
$enableBaz: Boolean = false,
) {
foo(id: $id) {
baz @include(if: $enableBaz) {

"Some description here"
fragment BazInfo on Baz {
# ...