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

update out-of-sync API documentation #242

Open
jocrah opened this issue Oct 9, 2022 · 2 comments
Open

update out-of-sync API documentation #242

jocrah opened this issue Oct 9, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation high priority task

Comments

@jocrah
Copy link
Contributor

jocrah commented Oct 9, 2022

Task Description

Some of our API endpoints are out of sync with what is expected from the code itself. This task is to ensure we have the right information in the documentation.

This is more of an investigative task to go through the currently defined endpoint schemas and make sure the API documentation reflects exactly what the code is expecting. This also applies to the expected responses as well

@jocrah jocrah added documentation Improvements or additions to documentation task labels Oct 9, 2022
@jocrah jocrah mentioned this issue Oct 13, 2022
7 tasks
@jakazzy
Copy link
Contributor

jakazzy commented Nov 6, 2022

@beblicarl have all the endpoints been documented now?

@jocrah
Copy link
Contributor Author

jocrah commented Nov 7, 2022

have all the endpoints been documented now?

that's possible but this is mainly to make sure everything about the requests we have documented so far matches what the code has.

Mainly, the request bodies and the responses and anything else

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation high priority task
Projects
Status: No status
Development

No branches or pull requests

2 participants