graphql
Docs should explain "data" object in results
Maybe I just missed it, but the docs mysteriously show a "data" object that wasn't queried for, and I can't find the explanation.
Newbies like me could use:
- An explanation early in the docs.
- Is this a convention or requirement?
- It might be worth also mentioning the "errors" object I see in later examples.
👋🏼 @JVimes, thanks for opening an issue on the GraphQL documentation! I totally agree with you, this should be more clear early-on in the documentation and learning journey through the docs.
I'd lean towards adding it on the Queries and Mutations, right after the introduction and where this data object is first introduced. Would you agree?
I also agree with adding a similar note about the errors object. I wonder if that would be best when the first example is introduced (in Schemas and Types) or mentioned in the note about data (or both). Would be curious to hear what you think!
Thank you @carolstran! Yes, I think it'll work well to define each (data and errors) with its first appearance in the docs. Consider briefly mentioning errors when you introduce data. This will satisfy curiosity as to why the data is not at the root level (to leave a place for errors).