opensearch-project
[DOC] Error responses missing in REST API documentation
What do you want to do?
- [x] Request a change to existing documentation
- [ ] Add new documentation
- [ ] Report a technical problem with the documentation
- [ ] Other
APIs in the documentation show response for success scenario. Responses for error scenarios are not added.
Consider this as an example. Response body is missing for error status codes like 4xx, 5xx, etc.
Refer this issue.
@imvtsl - Thanks for submitting an issue, @imvtsl! Can you please check the link above (this issue), as I think you may have added the wrong link.
@dblock and @imvtsl: Would a page of common response codes be a good solution for this issue?
APIs are not consistent with the error responses. For example, delete document API. See this issue for more details. Therefore, a page of common error responses would not work for all APIs.
Ideally, error messages should be consistent and self-explanatory. If they are, then we'd only need to provide the possible HTTP response codes in the troubleshooting section. We should try to fix this at the product level.
