Skip to content

Sync OpenAPI Schema (18994) - #496

Open
fingerprint-dx-team-actions-runner[bot] wants to merge 1 commit into
mainfrom
sync-18994
Open

fingerprint-dx-team-actions-runner[bot] wants to merge 1 commit into
mainfrom
sync-18994

Conversation

@fingerprint-dx-team-actions-runner

Copy link
Copy Markdown
Contributor

This PR automatically updates the OpenAPI schema.

Changes

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

Modified files
  • schemas/paths/event.yaml
Added files
  • schemas/paths/examples/errors/400_edge_event_not_updatable.json
  • schemas/paths/examples/errors/400_event_too_old.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

fingerprint-dx-team-actions-runner Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor Author

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

@changeset-bot

changeset-bot Bot commented Oct 22, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 619526b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@github-actions

Copy link
Copy Markdown
Contributor

Schema Diff vs Published Schemas

  • Generated at: 2026-10-22T08:46:39.940Z
  • 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: +0 added, -0 removed, ~2 modified

Added elements (0)

None

Removed elements (0)

None

Modified elements (2)
  • /paths/~1events~1{event_id}/patch/description
  • /paths/~1events~1{event_id}/patch/responses/400/description
Changed lines patch
--- a/schemas/fingerprint-server-api-v4-normalized.yaml
+++ b/schemas/fingerprint-server-api-v4-normalized.yaml
@@ -143,11 +143,18 @@
 
         This information might not have been available on the client initially,
         so the Server API permits updating these attributes after the fact.
 
 
-        **Warning** It's not possible to update events older than one month. 
+        **Warning** You can only update events created within the last 10 days.
+        Updating an older event returns HTTP 400 with the message `event is too
+        old to be updated (> 10 days)`, even if your plan retains events for
+        longer.
+
+
+        **Warning** Events created by the Automation Intelligence API (`POST
+        /edge`) cannot be updated. Updating them returns HTTP 400.
 
 
         **Warning** Trying to update an event immediately after creation may
         temporarily result in an 
 
@@ -174,11 +181,13 @@
               $ref: '#/components/schemas/EventUpdate'
       responses:
         '200':
           description: OK.
         '400':
-          description: Bad request. The request payload is not valid.
+          description: >-
+            Bad request. The request payload is not valid, the event is older
+            than 10 days, or the event cannot be updated.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '403':

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, -0 removed, ~2 modified

Added elements (2)
  • /paths/~1events~1{event_id}/patch/responses/400/content/application~1json/examples/400-edge-event-not-updatable
  • /paths/~1events~1{event_id}/patch/responses/400/content/application~1json/examples/400-event-too-old
Removed elements (0)

None

Modified elements (2)
  • /paths/~1events~1{event_id}/patch/description
  • /paths/~1events~1{event_id}/patch/responses/400/description
Changed lines patch
--- a/schemas/fingerprint-server-api-v4-with-examples.yaml
+++ b/schemas/fingerprint-server-api-v4-with-examples.yaml
@@ -1355,11 +1355,18 @@
 
         This information might not have been available on the client initially,
         so the Server API permits updating these attributes after the fact.
 
 
-        **Warning** It's not possible to update events older than one month. 
+        **Warning** You can only update events created within the last 10 days.
+        Updating an older event returns HTTP 400 with the message `event is too
+        old to be updated (> 10 days)`, even if your plan retains events for
+        longer.
+
+
+        **Warning** Events created by the Automation Intelligence API (`POST
+        /edge`) cannot be updated. Updating them returns HTTP 400.
 
 
         **Warning** Trying to update an event immediately after creation may
         temporarily result in an 
 
@@ -1385,11 +1392,13 @@
               $ref: '#/components/schemas/EventUpdate'
       responses:
         '200':
           description: OK.
         '400':
-          description: Bad request. The request payload is not valid.
+          description: >-
+            Bad request. The request payload is not valid, the event is older
+            than 10 days, or the event cannot be updated.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
               examples:
@@ -1399,10 +1408,26 @@
                     valid and cannot be parsed.
                   value:
                     error:
                       code: request_cannot_be_parsed
                       message: request body is not valid
+                400-event-too-old:
+                  summary: >-
+                    Error response when the event was created more than 10 days
+                    ago.
+                  value:
+                    error:
+                      code: failed
+                      message: event is too old to be updated (> 10 days)
+                400-edge-event-not-updatable:
+                  summary: >-
+                    Error response when the event was created by the Automation
+                    Intelligence API and cannot be updated.
+                  value:
+                    error:
+                      code: failed
+                      message: edge events cannot be updated
         '403':
           description: Forbidden. Access to this API is denied.
           content:
             application/json:
               schema:

fingerprint-server-api-v4.yaml

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

Added elements (0)

None

Removed elements (0)

None

Modified elements (2)
  • /paths/~1events~1{event_id}/patch/description
  • /paths/~1events~1{event_id}/patch/responses/400/description
Changed lines patch
--- a/schemas/fingerprint-server-api-v4.yaml
+++ b/schemas/fingerprint-server-api-v4.yaml
@@ -143,11 +143,18 @@
 
         This information might not have been available on the client initially,
         so the Server API permits updating these attributes after the fact.
 
 
-        **Warning** It's not possible to update events older than one month. 
+        **Warning** You can only update events created within the last 10 days.
+        Updating an older event returns HTTP 400 with the message `event is too
+        old to be updated (> 10 days)`, even if your plan retains events for
+        longer.
+
+
+        **Warning** Events created by the Automation Intelligence API (`POST
+        /edge`) cannot be updated. Updating them returns HTTP 400.
 
 
         **Warning** Trying to update an event immediately after creation may
         temporarily result in an 
 
@@ -174,11 +181,13 @@
               $ref: '#/components/schemas/EventUpdate'
       responses:
         '200':
           description: OK.
         '400':
-          description: Bad request. The request payload is not valid.
+          description: >-
+            Bad request. The request payload is not valid, the event is older
+            than 10 days, or the event cannot be updated.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '403':

@github-actions

Copy link
Copy Markdown
Contributor

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

openapi@3.9.1

Patch Changes

  • Set the Server API v3 deprecation date to October 31, 2026 and the end-of-life date to October 31, 2027 in the endpoint descriptions (9790b00)

@fingerprint-dx-team-actions-runner fingerprint-dx-team-actions-runner Bot changed the title Sync OpenAPI Schema (18994) Sync OpenAPI Schema (18994) - events: Clarify update age limit and add edge event error examples Oct 22, 2026
@fingerprint-dx-team-actions-runner

Copy link
Copy Markdown
Contributor Author

🤖 events: Clarify update age limit and add edge event error examples

The diff updates the PATCH /events/{request_id} endpoint in three ways:

  1. The update age limit warning was tightened from "one month" to 10 days, with an explicit error message (event is too old to be updated (> 10 days)).
  2. A new warning documents that events created via the Automation Intelligence API (POST /edge) cannot be updated at all.
  3. Two named 400 error examples were added to the schema (400-event-too-old, 400-edge-event-not-updatable), along with their corresponding JSON example files.

Changesets: None added. All changes are descriptions, warning text, and error examples — no new fields, schemas, or endpoints that would affect SDK code generation. Per CONTRIBUTING.md, documentation-only changes and examples don't require a changeset.

Straightforward — no ambiguity.

@fingerprint-dx-team-actions-runner fingerprint-dx-team-actions-runner Bot changed the title Sync OpenAPI Schema (18994) - events: Clarify update age limit and add edge event error examples Sync OpenAPI Schema (18994) Oct 22, 2026

This branch was successfully deployed

1 active deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants