Add queries to auto generated Graphql docs
The current state of documentation renderer for GraphQL only generates
documentation for object types, like Project, MergeRequest, User etc.
To make the generated docs more useful we should generate documentation for queries.
Proposal
Add queries to the template used for generating the docs. Each query has a return type and it should be linked to its correspondent object documentation which is already generated.
- We can consider moving objects to a separate page if rendering queries and objects in just one page does not look good.(Can be done if needed in another issue)
EDIT: We decided to add queries to the same page of types for a first iteration.
How to do it
Query objects can be accessed using a helper method called graphql_operation_types
on the default template. Once the necessary changes are made to the template run rake gitlab:graphql:compile_docs
and check the generated docs.
Edited by Felipe Cardozo