How to run a mutation? Add example to Readme

[graphql]

How to run a mutation? Add example to Readme

[sarink]

If you're like me, you simply missed the sneaky "variables" input box (bottom left corner):

[tinnou]

Let say your ChangeCohortInput has the fields clientMutationId and title.

Your mutation would look like:

mutation example($cohort: ChangeCohortInput!){
  change_cohort(input: $cohort) {
    user {
      cohort {
        title
      }
    }
  }
}

and variables

{
  "cohort": {
    "clientMutationId": "random",
    "title": "New cohort title"
  }
}

[holmesal]

@asiandrummer I think a lot of people (like me, 5 minutes in the past 😁) are going to land on the graphiql README looking for precisely the example above, and while the graphql specification document technically has the info you need, it's a lot to parse/search.

Might be worth adding an example for first-timers?

[asiandrummer]

Per lots of requests for the examples in README (simple query examples && GraphiQL component customizations), I'm working on adding/improving the README. Please stay tuned for upcoming updates :D

[extrajordanary]

@asiandrummer greatly appreciate it, really do love using GraphiQL :)

[asiandrummer]

Thanks for the answer @tinnou. I do feel like the example for mutation operation better belongs to GraphQL Specifications Document, as it already explains the correct specifications, requirements, and examples for running a mutation operation.

[extrajordanary]

@asiandrummer I agree with @holmesal, the GraphQL Specifications Document is extremely dense. I would never be able to find the info needed within it if I didn't already know what the answer is so that I can ctrl-f the page for $.

the screenshot on the readme alone is already a 100% improvement, but even a simple list of links to the most relevant parts of the GraphQL Specifications Document would be another good and not-too-painful improvement for users

[asiandrummer]

Alright, I've tried adding some examples to README - go check it out!
I'll close this issue for now, but if you have any other suggestions, feel free to open another issue or reopen this one.