Skip to content

[Task] Documentation for GraphQL #878

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

Closed
andrewazores opened this issue Apr 5, 2022 · 1 comment · Fixed by #1075
Closed

[Task] Documentation for GraphQL #878

andrewazores opened this issue Apr 5, 2022 · 1 comment · Fixed by #1075

Comments

@andrewazores
Copy link
Member

GraphQL for 2.1.0 is feature-complete after #872 is merged. We need upstream development-level docs for this feature, including an entry in HTTP_API.md.

cryostatio/cryostat#872 (comment)

It probably makes more sense to document the various queries/mutations implemented and the possible filter inputs and the behaviour of using multiple filter input fields somewhere separately from HTTP_API.md, since that's a lot of content specific to just one high-powered API endpoint. The existing GRAPHQL.md could be a good candidate for reuse here.

@andrewazores
Copy link
Member Author

My current thought is that we should simply document the top-level GraphQL endpoint(s), ex. POST /api/v2.2/graphql as the entrypoint, and have a high-level description of what this API surface is used for with a few useful examples. I don't think we should try to fully, exhaustively document this API surface in a markdown document however. Rather, we should simply refer the reader to the queries.graphqls and types.graphqls files. These already describe the API in good detail to readers who have familiarity with GraphQL.

Repository owner moved this from Todo to Done in 2.2.0 Release Sep 20, 2022
Repository owner moved this from Pushed to Next Release to Done in 2.1.0 Release Sep 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant