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

Add documentation comments for GraphQL APIs, if they are missing #273

Open
sophie-cluml opened this issue Aug 21, 2024 · 1 comment
Open

Comments

@sophie-cluml
Copy link
Contributor

sophie-cluml commented Aug 21, 2024

It would be helpful to provide client-side friendly GraphQL API documentation, allowing client-side development to proceed without needing to understand the details of review-web. Developers could simply reference the GraphQL API schema, typically in SDL format. Some APIs have documentation, but not all are documented. So, I think this would mainly involve adding missing documentation comments in the relevant code.

@sophie-cluml sophie-cluml changed the title Add documentation comment for GraphQL APIs Add missing documentation comment for GraphQL APIs Aug 21, 2024
@sophie-cluml sophie-cluml changed the title Add missing documentation comment for GraphQL APIs Add documentation comments for GraphQL APIs, if they are missing Aug 21, 2024
@sehkone
Copy link
Contributor

sehkone commented Sep 1, 2024

Regarding the APIs to return values parsed from packets, we need to not only fill in the missing ones but also ensure their descriptions are legitimate according to the standard protocols. Since the current API names do not clearly indicate the meaning of the values they return, it would be better to elaborate on them with descriptive texts. I asked Parker and Ben to add proper descriptions to each API in Notion, and I think this issue should be addressed after that is completed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants