Skip to content

Sync OpenAPI Schema (18693) - schema: Add 503 response, deprecate 504 on event GET endpoints #486

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.

Sign up for GitHub

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

Merged
Orkuncakilkaya merged 4 commits into from
Oct 6, 2026
Merged

Sync OpenAPI Schema (18693) - schema: Add 503 response, deprecate 504 on event GET endpoints #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ca1265f
chore: sync OpenAPI schema
fingerprint-dx-team-actions-runner[bot] Oct 1, 2026
8e8df30
chore: add changeset error-response-503-events-search.md [skip ci-ai-…
fingerprint-dx-team-actions-runner[bot] Oct 1, 2026
c69ca0f
chore: add changeset error-response-503-events.md [skip ci-ai-prep]
fingerprint-dx-team-actions-runner[bot] Oct 1, 2026
58b5345
Merge branch 'main' into sync-18693
Orkuncakilkaya Oct 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/error-response-503-events-search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'openapi': minor
---

**events-search**: Add `503` Service Temporarily Unavailable response to the Events Search endpoint
5 changes: 5 additions & 0 deletions .changeset/error-response-503-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'openapi': minor
---

**events**: Add `503` Service Temporarily Unavailable response to the Get Event endpoint
21 changes: 12 additions & 9 deletions schemas/paths/event.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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
Expand Down
21 changes: 12 additions & 9 deletions schemas/paths/events.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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
6 changes: 6 additions & 0 deletions schemas/paths/examples/errors/503_service_unavailable.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"error": {
"code": "service_unavailable",
"message": "service temporarily unavailable"
}
}
Loading