Improve Guides and Documentation of the Admin API

[fungc-io]

Problem

• people need to learn graphql before they can know is a certain action doable
• GraphQL is still relatively new for many developers. Beginners do not even know where to start.
• Users need to signup for an account before trying out the GraphiQL Explorer
• They can only try with live, production data in GraphiQL

Appetite

2 weeks

Solution

1. Improve the raw .graphql to give more description and comments

   • This also improve the experience of the GraphiQL Explorer

2. Generate an HTML version of .graphql as a reference

   • Try out https://github.com/anvilco/spectaql

3. Provide more examples for different actions in the docs: https://docs.authgear.com/apis/admin-api/api-examples

   • Query user info
   • Disable/Delete a user
   • Query audit logs

Rabbit holes

Details about the solution worth calling out to avoid problems

No-goes

Functionality or use cases we intentionally aren’t covering to fit the appetite

Do not work on a sandbox GraphiQL Explorer, which is mentioned in https://github.com/authgear/authgear-server/issues/2668