diff --git a/.changeset/error-response-503-events-search.md b/.changeset/error-response-503-events-search.md new file mode 100644 index 00000000..dd1b516e --- /dev/null +++ b/.changeset/error-response-503-events-search.md @@ -0,0 +1,5 @@ +--- +'openapi': minor +--- + +**events-search**: Add `503` Service Temporarily Unavailable response to the Events Search endpoint diff --git a/.changeset/error-response-503-events.md b/.changeset/error-response-503-events.md new file mode 100644 index 00000000..a53c2f9c --- /dev/null +++ b/.changeset/error-response-503-events.md @@ -0,0 +1,5 @@ +--- +'openapi': minor +--- + +**events**: Add `503` Service Temporarily Unavailable response to the Get Event endpoint diff --git a/schemas/paths/event.yaml b/schemas/paths/event.yaml index 0eae368e..bfdd6b85 100644 --- a/schemas/paths/event.yaml +++ b/schemas/paths/event.yaml @@ -85,7 +85,6 @@ get: '429': description: | Too Many Requests. The request is throttled. - To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message `too many search requests` even if you are within your assigned rate limits. content: application/json: schema: @@ -94,9 +93,6 @@ get: 429-too-many-requests-error: summary: Too many requests error externalValue: examples/errors/429_too_many_requests.json - 429-too-many-search-requests-error: - summary: Error response when search traffic is throttled to protect service stability during rare periods of extreme load, even if you are within your assigned rate limits. - externalValue: examples/errors/429_too_many_search_requests.json '500': description: Workspace error. content: @@ -107,16 +103,23 @@ get: 500-error: summary: Request failed externalValue: examples/errors/500_internal_server_error.json - '504': - description: Gateway Timeout. Search execution exceeded the allowed timeout window. + '503': + description: Service Temporarily Unavailable. content: application/json: schema: $ref: ../components/schemas/error/ErrorResponse.yaml examples: - 504-search-timeout-exceeded: - summary: Error response when search execution exceeds the allowed timeout window. - externalValue: examples/errors/504_search_timeout_exceeded.json + 503-service-temporarily-unavailable: + summary: Error response when the service is temporarily unavailable. + externalValue: examples/errors/503_service_unavailable.json + '504': + description: Gateway Timeout. + x-deprecated-response: true + content: + application/json: + schema: + $ref: ../components/schemas/error/ErrorResponse.yaml patch: tags: - Events diff --git a/schemas/paths/events.yaml b/schemas/paths/events.yaml index a9a81c2f..0793696d 100644 --- a/schemas/paths/events.yaml +++ b/schemas/paths/events.yaml @@ -613,7 +613,6 @@ get: '429': description: | Too Many Requests. The request is throttled. - To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message `too many search requests` even if you are within your assigned rate limits. content: application/json: schema: @@ -622,9 +621,6 @@ get: 429-too-many-requests-error: summary: Too many requests error externalValue: examples/errors/429_too_many_requests.json - 429-too-many-search-requests-error: - summary: Error response when search traffic is throttled to protect service stability during rare periods of extreme load, even if you are within your assigned rate limits. - externalValue: examples/errors/429_too_many_search_requests.json '500': description: Workspace error. content: @@ -635,13 +631,20 @@ get: 500-error: summary: Request failed externalValue: examples/errors/500_internal_server_error.json - '504': - description: Gateway Timeout. Search execution exceeded the allowed timeout window. + '503': + description: Service Temporarily Unavailable. content: application/json: schema: $ref: ../components/schemas/error/ErrorResponse.yaml examples: - 504-search-timeout-exceeded: - summary: Error response when search execution exceeds the allowed timeout window. - externalValue: examples/errors/504_search_timeout_exceeded.json + 503-service-temporarily-unavailable: + summary: Error response when the service is temporarily unavailable. + externalValue: examples/errors/503_service_unavailable.json + '504': + description: Gateway Timeout. + x-deprecated-response: true + content: + application/json: + schema: + $ref: ../components/schemas/error/ErrorResponse.yaml diff --git a/schemas/paths/examples/errors/503_service_unavailable.json b/schemas/paths/examples/errors/503_service_unavailable.json new file mode 100644 index 00000000..aebf5cdd --- /dev/null +++ b/schemas/paths/examples/errors/503_service_unavailable.json @@ -0,0 +1,6 @@ +{ + "error": { + "code": "service_unavailable", + "message": "service temporarily unavailable" + } +}