Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: standardize graphql api examples #3090

Open
melissahenderson opened this issue Nov 7, 2024 · 0 comments
Open

docs: standardize graphql api examples #3090

melissahenderson opened this issue Nov 7, 2024 · 0 comments
Labels
user-doc-priority: low User doc priority is low user-docs

Comments

@melissahenderson
Copy link
Contributor

melissahenderson commented Nov 7, 2024

We'll talk about this before working on it.

Example of what we want will eventually be available at /admin/liquidity/asset-liquidity#deposit-asset-liquidity. #3139 must be completed first.

In general:

  • Shorten header to be more direct, don’t include mutation name, don’t include code style
  • If any code block is too long, use wrap (```graphql wrap)

Create three tabs.

Operation tab

  • Add the mutation to a code block
  • Specify graphql as the language

Arguments tab

  • Add the JSON request to a code block
  • Specify json as the language
  • Delete the variable/description table
  • Beneath the code block, add For more information about this mutation's input object, see NameOfInputObjectInput. Link the input object to its page in the API docs.

Response tab

  • Add the JSON response to a code block
  • Specify json as the language
@github-project-automation github-project-automation bot moved this to Backlog in Rafiki Nov 7, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Documentation Nov 7, 2024
@melissahenderson melissahenderson changed the title docs: standardize mutation and request/response examples docs: standardize graphql api examples Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user-doc-priority: low User doc priority is low user-docs
Projects
Status: Backlog
Status: Backlog
Development

No branches or pull requests

1 participant