Release [changeset]

[fingerprint-dx-team-actions-runner]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or setup this action to publish automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

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)

[github-actions]

⚠️ This PR doesn't contain any changesets. If there are user-facing changes, don't forget to run:

pnpm run changeset

to create a changeset.

[github-actions]

Schema Diff vs Published Schemas

• Generated at: 2026-10-06T08:50:37.432Z
• 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}: