Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarification on "Schemas and Types" documentation #1531

Open
alexworden opened this issue Aug 14, 2023 · 0 comments
Open

Clarification on "Schemas and Types" documentation #1531

alexworden opened this issue Aug 14, 2023 · 0 comments

Comments

@alexworden
Copy link

Hoping my input from a GraphQL newbie reading your documentation is helpful. This section https://graphql.org/learn/schema/#the-query-and-mutation-types needs a more verbose explanation. It's not clear why I would define the Query and Mutation types in my own schema if they are already reserved entities in GraphQL. Are you suggesting that 'query' and 'mutation' are example entities or example types "Query" and "Mutation"? If so, I'd recommend prepending "my" to them to make this obvious. If not examples, why are they being defined? Can a schema have only one Query and one Mutation? It's confusing to someone new to GraphQL and I think some more verbose explanation and better example would be useful.

Also in this page, it seems like a bad idea to define an enumeration like Episode, of which the content is dynamic data. A better enumeration example would be something where the data items are expected to never change. E.g. Units = Kilometers | Miles

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant