opensearch-project / opensearch-api-specification

API specification for OpenSearch
Apache License 2.0
32 stars 48 forks source link

[BUG] Error responses missing in API specs #445

Open imvtsl opened 1 month ago

imvtsl commented 1 month ago

What is the bug?

APIs in the specification show response for success scenario. Responses for error scenarios are not added.

How can one reproduce the bug?

Consider this API spec as an example. Response body is missing for error status codes like 4xx, 5xx, etc.

What is the expected behavior?

The spec should have error responses to improve usability of the APIs.

dblock commented 1 month ago

💯 error responses are totally missing in most places, they often have common definitions, too