Sync OpenAPI Schema (18693) - schema: Add 503 response, deprecate 504 on event GET endpoints by fingerprint-dx-team-actions-runner[bot] · Pull Request #486 · fingerprintjs/openapi

fingerprint-dx-team-actions-runner · 2026-10-01T22:26:37Z

This PR automatically updates the OpenAPI schema.

Changes

2 file(s) modified, 1 file(s) added

Modified files

schemas/paths/event.yaml
schemas/paths/events.yaml

Added files

schemas/paths/examples/errors/503_service_unavailable.json

Note for reviewers: Please review the schema changes.
You likely need to manually add a changeset file to this branch before merging.

fingerprint-dx-team-actions-runner · 2026-10-01T22:26:40Z

✅The changes have been finalized. This PR is ready for review.

changeset-bot · 2026-10-01T22:26:47Z

🦋 Changeset detected

Latest commit: 58b5345

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
openapi	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2026-10-01T22:27:08Z

Schema Diff vs Published Schemas

Generated at: 2026-10-06T08:43:49.452Z
Published source: https://fingerprintjs.github.io/openapi/schemas
Compared schemas: 8
Changed schemas: 3

`fingerprint-server-api-v4-normalized.yaml`

Published URL: https://fingerprintjs.github.io/openapi/schemas/fingerprint-server-api-v4-normalized.yaml
Summary: +4 added, -0 removed, ~4 modified

Added elements (4)

/paths/~1events/get/responses/503
/paths/~1events/get/responses/504/x-deprecated-response
/paths/~1events~1{event_id}/get/responses/503
/paths/~1events~1{event_id}/get/responses/504/x-deprecated-response

Removed elements (0)

None

Modified elements (4)

/paths/~1events/get/responses/429/description
/paths/~1events/get/responses/504/description
/paths/~1events~1{event_id}/get/responses/429/description
/paths/~1events~1{event_id}/get/responses/504/description

Changed lines patch

--- a/schemas/fingerprint-server-api-v4-normalized.yaml
+++ b/schemas/fingerprint-server-api-v4-normalized.yaml
@@ -101,30 +101,31 @@
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '429':
-          description: >
+          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:
                 $ref: '#/components/schemas/ErrorResponse'
         '500':
           description: Workspace error.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '503':
+          description: Service Temporarily Unavailable.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
         '504':
-          description: >-
-            Gateway Timeout. Search execution exceeded the allowed timeout
-            window.
+          description: Gateway Timeout.
+          x-deprecated-response: true
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
     patch:
@@ -1016,30 +1017,31 @@
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '429':
-          description: >
+          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:
                 $ref: '#/components/schemas/ErrorResponse'
         '500':
           description: Workspace error.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '503':
+          description: Service Temporarily Unavailable.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
         '504':
-          description: >-
-            Gateway Timeout. Search execution exceeded the allowed timeout
-            window.
+          description: Gateway Timeout.
+          x-deprecated-response: true
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
   /visitors/{visitor_id}:

`fingerprint-server-api-v4-with-examples.yaml`

Published URL: https://fingerprintjs.github.io/openapi/schemas/fingerprint-server-api-v4-with-examples.yaml
Summary: +2 added, -4 removed, ~2 modified

Added elements (2)

/paths/~1events/get/responses/503
/paths/~1events~1{event_id}/get/responses/503

Removed elements (4)

/paths/~1events/get/responses/429/content/application~1json/examples/429-too-many-search-requests-error
/paths/~1events/get/responses/504
/paths/~1events~1{event_id}/get/responses/429/content/application~1json/examples/429-too-many-search-requests-error
/paths/~1events~1{event_id}/get/responses/504

Modified elements (2)

/paths/~1events/get/responses/429/description
/paths/~1events~1{event_id}/get/responses/429/description

Changed lines patch

--- a/schemas/fingerprint-server-api-v4-with-examples.yaml
+++ b/schemas/fingerprint-server-api-v4-with-examples.yaml
@@ -1299,16 +1299,12 @@
                   value:
                     error:
                       code: event_not_found
                       message: event id not found
         '429':
-          description: >
+          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:
                 $ref: '#/components/schemas/ErrorResponse'
               examples:
@@ -1316,19 +1312,10 @@
                   summary: Too many requests error
                   value:
                     error:
                       code: too_many_requests
                       message: too many requests
-                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.
-                  value:
-                    error:
-                      code: too_many_requests
-                      message: too many search requests
         '500':
           description: Workspace error.
           content:
             application/json:
               schema:
@@ -1338,27 +1325,23 @@
                   summary: Request failed
                   value:
                     error:
                       code: failed
                       message: internal server error
-        '504':
-          description: >-
-            Gateway Timeout. Search execution exceeded the allowed timeout
-            window.
+        '503':
+          description: Service Temporarily Unavailable.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
               examples:
-                504-search-timeout-exceeded:
-                  summary: >-
-                    Error response when search execution exceeds the allowed
-                    timeout window.
+                503-service-temporarily-unavailable:
+                  summary: Error response when the service is temporarily unavailable.
                   value:
                     error:
-                      code: failed
-                      message: gateway timeout
+                      code: service_unavailable
+                      message: service temporarily unavailable
     patch:
       tags:
         - Events
       operationId: updateEvent
       summary: Update an event
@@ -2785,16 +2768,12 @@
                   value:
                     error:
                       code: visitor_not_found
                       message: visitor not found
         '429':
-          description: >
+          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:
                 $ref: '#/components/schemas/ErrorResponse'
               examples:
@@ -2802,19 +2781,10 @@
                   summary: Too many requests error
                   value:
                     error:
                       code: too_many_requests
                       message: too many requests
-                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.
-                  value:
-                    error:
-                      code: too_many_requests
-                      message: too many search requests
         '500':
           description: Workspace error.
           content:
             application/json:
               schema:
@@ -2824,27 +2794,23 @@
                   summary: Request failed
                   value:
                     error:
                       code: failed
                       message: internal server error
-        '504':
-          description: >-
-            Gateway Timeout. Search execution exceeded the allowed timeout
-            window.
+        '503':
+          description: Service Temporarily Unavailable.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
               examples:
-                504-search-timeout-exceeded:
-                  summary: >-
-                    Error response when search execution exceeds the allowed
-                    timeout window.
+                503-service-temporarily-unavailable:
+                  summary: Error response when the service is temporarily unavailable.
                   value:
                     error:
-                      code: failed
-                      message: gateway timeout
+                      code: service_unavailable
+                      message: service temporarily unavailable
   /visitors/{visitor_id}:
     delete:
       tags:
         - Visitors
       operationId: deleteVisitorData

`fingerprint-server-api-v4.yaml`

Published URL: https://fingerprintjs.github.io/openapi/schemas/fingerprint-server-api-v4.yaml
Summary: +4 added, -0 removed, ~4 modified

Added elements (4)

/paths/~1events/get/responses/503
/paths/~1events/get/responses/504/x-deprecated-response
/paths/~1events~1{event_id}/get/responses/503
/paths/~1events~1{event_id}/get/responses/504/x-deprecated-response

Removed elements (0)

None

Modified elements (4)

/paths/~1events/get/responses/429/description
/paths/~1events/get/responses/504/description
/paths/~1events~1{event_id}/get/responses/429/description
/paths/~1events~1{event_id}/get/responses/504/description

Changed lines patch

--- a/schemas/fingerprint-server-api-v4.yaml
+++ b/schemas/fingerprint-server-api-v4.yaml
@@ -101,30 +101,31 @@
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '429':
-          description: >
+          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:
                 $ref: '#/components/schemas/ErrorResponse'
         '500':
           description: Workspace error.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '503':
+          description: Service Temporarily Unavailable.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
         '504':
-          description: >-
-            Gateway Timeout. Search execution exceeded the allowed timeout
-            window.
+          description: Gateway Timeout.
+          x-deprecated-response: true
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
     patch:
@@ -1002,30 +1003,31 @@
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '429':
-          description: >
+          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:
                 $ref: '#/components/schemas/ErrorResponse'
         '500':
           description: Workspace error.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '503':
+          description: Service Temporarily Unavailable.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
         '504':
-          description: >-
-            Gateway Timeout. Search execution exceeded the allowed timeout
-            window.
+          description: Gateway Timeout.
+          x-deprecated-response: true
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
   /visitors/{visitor_id}:

…prep]

fingerprint-dx-team-actions-runner · 2026-10-01T22:28:42Z

🤖 Proposed title addition: schema: Add 503 response, deprecate 504 on event GET endpoints

Both the Get Event (/events/{event_id}) and Events Search (/events) GET endpoints gained a 503 Service Temporarily Unavailable response and had 504 marked deprecated via x-deprecated-response: true. A search-traffic-specific 429 example was also removed from both endpoints.

Two changesets were added — one per affected scope:

error-response-503-events.md — events, minor
error-response-503-events-search.md — events-search, minor

The 504 deprecation (x-deprecated-response: true) and the 429 example removal were treated as documentation-only — no changeset needed for those. Straightforward diff overall.

github-actions · 2026-10-06T08:43:52Z

🚀 Following releases will be created using changesets from this PR:

openapi@3.9.0

Minor Changes

events-search: Add 503 Service Temporarily Unavailable response to the Events Search endpoint (8e8df30)
events: Add 503 Service Temporarily Unavailable response to the Get Event endpoint (c69ca0f)

chore: sync OpenAPI schema

ca1265f

fingerprint-dx-team-actions-runner Bot requested a review from a team as a code owner October 1, 2026 22:26

fingerprint-dx-team-actions-runner Bot deployed to test October 1, 2026 22:26 Active

fingerprint-dx-team-actions-runner Bot added 2 commits October 1, 2026 22:28

chore: add changeset error-response-503-events-search.md [skip ci-ai-…

8e8df30

…prep]

chore: add changeset error-response-503-events.md [skip ci-ai-prep]

c69ca0f

fingerprint-dx-team-actions-runner Bot changed the title ~~Sync OpenAPI Schema (18693)~~ Sync OpenAPI Schema (18693) - schema: Add 503 response, deprecate 504 on event GET endpoints Oct 1, 2026

fingerprint-dx-team-actions-runner Bot deployed to test October 1, 2026 22:28 Active

mcnulty-fp mentioned this pull request Oct 2, 2026

Hide deprecated 504 responses from schema #487

Merged

Merge branch 'main' into sync-18693

58b5345

Orkuncakilkaya deployed to test October 6, 2026 08:43 — with GitHub Actions Active

Orkuncakilkaya approved these changes Oct 6, 2026

View reviewed changes

Orkuncakilkaya merged commit 431b956 into main Oct 6, 2026
7 checks passed

Orkuncakilkaya deleted the sync-18693 branch October 6, 2026 08:48

Navigation Menu

Repository navigation

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

Sync OpenAPI Schema (18693) - schema: Add 503 response, deprecate 504 on event GET endpoints#486
Orkuncakilkaya merged 4 commits into
mainfrom
sync-18693

fingerprint-dx-team-actions-runner Bot commented Oct 1, 2026

Uh oh!

fingerprint-dx-team-actions-runner Bot commented Oct 1, 2026

Uh oh!

changeset-bot Bot commented Oct 1, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 1, 2026 •

edited

Loading

Uh oh!

fingerprint-dx-team-actions-runner Bot commented Oct 1, 2026

Uh oh!

github-actions Bot commented Oct 6, 2026

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

fingerprint-dx-team-actions-runner Bot commented Oct 1, 2026

Changes

Uh oh!

fingerprint-dx-team-actions-runner Bot commented Oct 1, 2026

Uh oh!

changeset-bot Bot commented Oct 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions Bot commented Oct 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Schema Diff vs Published Schemas

fingerprint-server-api-v4-normalized.yaml

fingerprint-server-api-v4-with-examples.yaml

fingerprint-server-api-v4.yaml

Uh oh!

fingerprint-dx-team-actions-runner Bot commented Oct 1, 2026

Uh oh!

github-actions Bot commented Oct 6, 2026

🚀 Following releases will be created using changesets from this PR:

openapi@3.9.0

Minor Changes

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

changeset-bot Bot commented Oct 1, 2026 •

edited

Loading

github-actions Bot commented Oct 1, 2026 •

edited

Loading

`fingerprint-server-api-v4-normalized.yaml`

`fingerprint-server-api-v4-with-examples.yaml`

`fingerprint-server-api-v4.yaml`