Add example of variable coercion failure

[wheresrhys]

Adds a concrete example to the variable coercion error

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: wheresrhys / name: Rhys Evans (6f6c1d8, 9ee5bd0)
• ✅ login: benjie / name: Benjie (acb8db3)
• ✅ login: spawnia / name: Benedikt Franke (acb8db3)

[benjie]

Excellent first step! I've fixed the syntax in the request and since it's a bit longer that the other examples I've broken it out into a code block. I've also made it clear that the example is well-formed to help readers understand the distinction. What do you think?

[benjie]

Excellent; please sign the CLA so that we can accept your contribution ❤️

[benjie]

We need to copy the RFC labels from the spec repo.

I see this as an editorial change; assuming there's no concerns raised in the next couple weeks I think we should merge it.

cc @abernix @balshor @benjie @deinok @ErikWittern @jaydenseric @michaelstaib @mike-marcacci @mmatsa @Shane32 @sjparsons @spawnia @sungam3r @Touchstone117 @enisdenjo @JoviDeCroock

[spawnia]

Suggested change

	"query": "query getItem($id: String!) { item(id: $id) { id } }",
	"query": "query ItemName($id: ID!) { item(id: $id) { id name } }",

The example works fine as is. However, I think it is more common to use PascalCase for operation names, and I also think it is best practice to use the ID type for identifiers.

[Shane32]

I think it is more common to use PascalCase for operation names

Perhaps; but I usually see schemas that follow this: https://www.apollographql.com/docs/technotes/TN0002-schema-naming-conventions/

I also think it is best practice to use the ID type for identifiers.

Agree

[spawnia]

https://www.apollographql.com/docs/technotes/TN0002-schema-naming-conventions/ does not explicitly talk about operation names, but its examples do use PascalCase (query Products).

[benjie]

I actually went through the spec and extracted the conventions from that; results are here:

https://benjie.dev/graphql/naming

The spec uses a mixture for operation names but camelCase is more common than UpperCamelCase. You may find the part on fragments interesting because I had a conversation with Lee about it.

[benjie]

I tweaked your example and committed that, I added a get prefix to match spec examples such as getDogName https://spec.graphql.org/draft/#example-069e1