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

Remove 500 codes from HTT_API.md #569

Closed
andrewazores opened this issue Jul 12, 2021 · 0 comments · Fixed by #875
Closed

Remove 500 codes from HTT_API.md #569

andrewazores opened this issue Jul 12, 2021 · 0 comments · Fixed by #875
Assignees

Comments

@andrewazores
Copy link
Member

500 Internal Server Error does not need to be documented for each API endpoint, since it's a possibility on any request and may happen for any reason. Specifying potential causes in the API document may mislead readers since this list of causes is almost certainly non-exhaustive, and is subject to change with the implementation - therefore, the 500 should not be counted as part of the published/stable API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants