CODEWITHSUNDEEP
hasura
Jakub Hampl
Jakub Hampl

Reputation: 40533

How to document a Hasura GraphQL API

My googling is surely failing me, but how would one document the fields and types in a GraphQL API produced by Hasura?

Upvotes: 2

Views: 320

Answers (1)

Shahidh
Shahidh

Reputation: 2682

Since field and types are auto-generated, documentation for them is taken from comments added to Tables and Columns. You can find them on the console as well as add to metadata yaml. These comments will then appear on the generated GraphQL schema.

See comments key in the example here.

Upvotes: 2

Related Questions