interledger / rafiki

An open-source, comprehensive Interledger service for wallet providers, enabling them to provide Interledger functionality to their users.
https://rafiki.dev/
Apache License 2.0
233 stars 83 forks source link

Docs: Add and revise field descriptions in Auth Admin API GraphQL schema #2987

Open brad-dow opened 1 week ago

brad-dow commented 1 week ago

Review Auth Admin API GraphQL reference docs for missing/incomplete field descriptions.

Add descriptions where elements are missing in the docs. Revise descriptions that need editing.

brad-dow commented 1 week ago

Keeping track of these here: https://docs.google.com/spreadsheets/d/1Q5enXt9QkMVpKn7ACbrhkplC52algbkDYPYFksJUIF4/edit?gid=1374687451#gid=1374687451

This branch contains the updated schema: https://github.com/interledger/rafiki/tree/docs-update-graphql-descriptions-auth

I need to get with @mkurapov to understand what other steps need to be taken before a schema change (even if it's only doc comments) can be pulled into main.