Release [changeset] by fingerprint-dx-team-actions-runner[bot] · Pull Request #472 · fingerprintjs/openapi

fingerprint-dx-team-actions-runner · 2026-09-07T09:50:39Z

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

fingerprint-pro-server-api-openapi@3.7.1

Patch Changes

Update API v3 error responses, timestamp formats, proxy metadata, and visitor endpoint documentation. Require Labels.label, set the default value of reverse to false, and limit VisitorsGetResponse.visits to one item. (53cf017)

github-actions · 2026-09-07T09:51:06Z

Schema Diff vs Published Schemas

Generated at: 2026-09-07T10:04:57.321Z
Published source: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas
Compared schemas: 8
Changed schemas: 3

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

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

Added elements (0)

None

Removed elements (0)

None

Modified elements (9)

/components/schemas/BundleId/description
/components/schemas/EnvironmentId/description
/components/schemas/LinkedId/description
/components/schemas/Velocity/description
/components/schemas/VelocityData/description
/paths/~1events/get/parameters/13/description
/paths/~1events~1{event_id}/get/responses/400/description
/paths/~1events~1{event_id}/get/responses/404/description
/paths/~1events~1{event_id}/patch/responses/404/description

Changed lines patch

--- a/schemas/fingerprint-server-api-v4-normalized.yaml
+++ b/schemas/fingerprint-server-api-v4-normalized.yaml
@@ -84,11 +84,11 @@
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Event'
         '400':
-          description: Bad request. The event Id provided is not valid.
+          description: Bad request. The event ID provided is not valid.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '403':
@@ -96,11 +96,11 @@
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '404':
-          description: Not found. The event Id cannot be found in this workspace's data.
+          description: Not found. The event ID cannot be found in this workspace's data.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '429':
@@ -186,11 +186,11 @@
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '404':
-          description: Not found. The event Id cannot be found in this workspace's data.
+          description: Not found. The event ID cannot be found in this workspace's data.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '409':
@@ -490,13 +490,13 @@
           description: >
             Filter events by your custom identifier.
 
 
             You can use [linked
-            Ids](https://docs.fingerprint.com/reference/js-agent-get-function#linkedid)
+            IDs](https://docs.fingerprint.com/reference/js-agent-get-function#linkedid)
             to associate identification requests with your own identifier, for
-            example, session Id, purchase Id, or transaction Id. You can then
+            example, session ID, purchase ID, or transaction ID. You can then
             use this `linked_id` parameter to retrieve all events associated
             with your custom identifier.
         - name: url
           in: query
           schema:
@@ -1167,11 +1167,11 @@
   schemas:
     LinkedId:
       type: string
       examples:
         - somelinkedId
-      description: A customer-provided id that was sent with the request.
+      description: A customer-provided ID that was sent with the request.
     Tags:
       type: object
       description: >-
         A customer-provided value or an object that was sent with the
         identification request or updated later.
@@ -1721,11 +1721,11 @@
         - completed
     EnvironmentId:
       type: string
       examples:
         - ae_47abaca3db2c7c43
-      description: Environment Id of the event.
+      description: Environment ID of the event.
     Suspect:
       type: boolean
       description: >-
         Field is `true` if you have previously set the `suspect` flag for this
         event using the [Server API Update event
@@ -1906,11 +1906,11 @@
     BundleId:
       type: string
       examples:
         - com.foo.app
       description: >
-        Bundle Id of the iOS application integrated with the Fingerprint SDK for
+        Bundle ID of the iOS application integrated with the Fingerprint SDK for
         the event.
     PackageName:
       type: string
       examples:
         - com.foo.app
@@ -2428,11 +2428,11 @@
             DolphinAnty, OctoBrowser, and GoLogin.
     VelocityData:
       type: object
       description: >
         Is absent if the velocity data could not be generated for the visitor
-        Id.
+        ID.
       required:
         - 5_minutes
         - 1_hour
       properties:
         5_minutes:
@@ -2463,34 +2463,34 @@
         `linked_id` at three distinct time
 
         intervals: 5 minutes, 1 hour, and 24 hours as follows: 
 
 
-        - Number of distinct IP addresses associated to the visitor Id.
+        - Number of distinct IP addresses associated to the visitor ID.
 
-        - Number of distinct linked Ids associated with the visitor Id.
+        - Number of distinct linked IDs associated with the visitor ID.
 
-        - Number of distinct countries associated with the visitor Id.
+        - Number of distinct countries associated with the visitor ID.
 
-        - Number of identification events associated with the visitor Id.
+        - Number of identification events associated with the visitor ID.
 
         - Number of identification events associated with the detected IP
         address.
 
         - Number of distinct IP addresses associated with the provided linked
-        Id.
+        ID.
 
-        - Number of distinct visitor Ids associated with the provided linked Id.
+        - Number of distinct visitor IDs associated with the provided linked ID.
 
 
         The `24_hours` interval of `distinct_ip`, `distinct_linked_id`,
         `distinct_country`,
 
         `distinct_ip_by_linked_id` and `distinct_visitor_id_by_linked_id` will
         be omitted 
 
-        if the number of `events` for the visitor Id in the last 24
+        if the number of `events` for the visitor ID in the last 24
 
         hours (`events.['24_hours']`) is higher than 20.000.
 
 
         All will not necessarily be returned in a response, some may be omitted

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

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

Added elements (0)

None

Removed elements (0)

None

Modified elements (16)

/components/schemas/BundleId/description
/components/schemas/EnvironmentId/description
/components/schemas/LinkedId/description
/components/schemas/Velocity/description
/components/schemas/VelocityData/description
/paths/~1events/get/parameters/13/description
/paths/~1events/get/responses/400/content/application~1json/examples/400-linked-id-invalid/summary
/paths/~1events/get/responses/400/content/application~1json/examples/400-visitor-id-invalid/summary
/paths/~1events~1{event_id}/get/responses/400/content/application~1json/examples/400-bad-request/summary
/paths/~1events~1{event_id}/get/responses/400/description
/paths/~1events~1{event_id}/get/responses/404/content/application~1json/examples/404-request-not-found/summary
/paths/~1events~1{event_id}/get/responses/404/description
/paths/~1events~1{event_id}/patch/responses/404/content/application~1json/examples/404-request-not-found/summary
/paths/~1events~1{event_id}/patch/responses/404/description
/paths/~1events~1{event_id}~1feedback/post/responses/404/content/application~1json/examples/404-event-not-found/summary
/paths/~1events~1{event_id}~1feedback/post/responses/404/description

Changed lines patch

--- a/schemas/fingerprint-server-api-v4-with-examples.yaml
+++ b/schemas/fingerprint-server-api-v4-with-examples.yaml
@@ -1231,18 +1231,18 @@
                     vpn_confidence: medium
                     vpn_methods:
                       public_vpn: false
                       relay: false
         '400':
-          description: Bad request. The event Id provided is not valid.
+          description: Bad request. The event ID provided is not valid.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
               examples:
                 400-bad-request:
-                  summary: Error response when the provided event Id is invalid.
+                  summary: Error response when the provided event ID is invalid.
                   value:
                     error:
                       code: request_cannot_be_parsed
                       message: invalid event_id
                 400-ruleset-not-found:
@@ -1275,18 +1275,18 @@
                       code: secret_api_key_not_found
                       message: >-
                         no fingerprint workspace found for specified secret API
                         key
         '404':
-          description: Not found. The event Id cannot be found in this workspace's data.
+          description: Not found. The event ID cannot be found in this workspace's data.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
               examples:
                 404-request-not-found:
-                  summary: Error response when the provided event Id does not exist.
+                  summary: Error response when the provided event ID does not exist.
                   value:
                     error:
                       code: event_not_found
                       message: event id not found
         '429':
@@ -1437,18 +1437,18 @@
                   value:
                     error:
                       code: wrong_region
                       message: wrong region
         '404':
-          description: Not found. The event Id cannot be found in this workspace's data.
+          description: Not found. The event ID cannot be found in this workspace's data.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
               examples:
                 404-request-not-found:
-                  summary: Error response when the provided event Id does not exist.
+                  summary: Error response when the provided event ID does not exist.
                   value:
                     error:
                       code: event_not_found
                       message: event id not found
         '409':
@@ -1560,18 +1560,18 @@
                       code: secret_api_key_not_found
                       message: >-
                         no fingerprint workspace found for specified secret API
                         key
         '404':
-          description: Not found. The event Id cannot be found in this workspace's data.
+          description: Not found. The event ID cannot be found in this workspace's data.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
               examples:
                 404-event-not-found:
-                  summary: Error response when the provided event Id does not exist.
+                  summary: Error response when the provided event ID does not exist.
                   value:
                     error:
                       code: event_not_found
                       message: event id not found
         '429':
@@ -1889,13 +1889,13 @@
           description: >
             Filter events by your custom identifier.
 
 
             You can use [linked
-            Ids](https://docs.fingerprint.com/reference/js-agent-get-function#linkedid)
+            IDs](https://docs.fingerprint.com/reference/js-agent-get-function#linkedid)
             to associate identification requests with your own identifier, for
-            example, session Id, purchase Id, or transaction Id. You can then
+            example, session ID, purchase ID, or transaction ID. You can then
             use this `linked_id` parameter to retrieve all events associated
             with your custom identifier.
         - name: url
           in: query
           schema:
@@ -2702,18 +2702,18 @@
                   value:
                     error:
                       code: request_cannot_be_parsed
                       message: invalid end time
                 400-visitor-id-invalid:
-                  summary: Error response when an invalid visitor Id is supplied.
+                  summary: Error response when an invalid visitor ID is supplied.
                   value:
                     error:
                       code: request_cannot_be_parsed
                       message: invalid visitor id
                 400-linked-id-invalid:
                   summary: >-
-                    Error response when an invalid (too large) linked Id is
+                    Error response when an invalid (too large) linked ID is
                     supplied.
                   value:
                     error:
                       code: request_cannot_be_parsed
                       message: linked_id can't be greater than 256 characters long
@@ -3042,11 +3042,11 @@
   schemas:
     LinkedId:
       type: string
       examples:
         - somelinkedId
-      description: A customer-provided id that was sent with the request.
+      description: A customer-provided ID that was sent with the request.
     Tags:
       type: object
       description: >-
         A customer-provided value or an object that was sent with the
         identification request or updated later.
@@ -3750,11 +3750,11 @@
         - completed
     EnvironmentId:
       type: string
       examples:
         - ae_47abaca3db2c7c43
-      description: Environment Id of the event.
+      description: Environment ID of the event.
     Suspect:
       type: boolean
       description: >-
         Field is `true` if you have previously set the `suspect` flag for this
         event using the [Server API Update event
@@ -3941,11 +3941,11 @@
     BundleId:
       type: string
       examples:
         - com.foo.app
       description: >
-        Bundle Id of the iOS application integrated with the Fingerprint SDK for
+        Bundle ID of the iOS application integrated with the Fingerprint SDK for
         the event.
     PackageName:
       type: string
       examples:
         - com.foo.app
@@ -4469,11 +4469,11 @@
             DolphinAnty, OctoBrowser, and GoLogin.
     VelocityData:
       type: object
       description: >
         Is absent if the velocity data could not be generated for the visitor
-        Id.
+        ID.
       additionalProperties: false
       required:
         - 5_minutes
         - 1_hour
       properties:
@@ -4505,34 +4505,34 @@
         `linked_id` at three distinct time
 
         intervals: 5 minutes, 1 hour, and 24 hours as follows: 
 
 
-        - Number of distinct IP addresses associated to the visitor Id.
+        - Number of distinct IP addresses associated to the visitor ID.
 
-        - Number of distinct linked Ids associated with the visitor Id.
+        - Number of distinct linked IDs associated with the visitor ID.
 
-        - Number of distinct countries associated with the visitor Id.
+        - Number of distinct countries associated with the visitor ID.
 
-        - Number of identification events associated with the visitor Id.
+        - Number of identification events associated with the visitor ID.
 
         - Number of identification events associated with the detected IP
         address.
 
         - Number of distinct IP addresses associated with the provided linked
-        Id.
+        ID.
 
-        - Number of distinct visitor Ids associated with the provided linked Id.
+        - Number of distinct visitor IDs associated with the provided linked ID.
 
 
         The `24_hours` interval of `distinct_ip`, `distinct_linked_id`,
         `distinct_country`,
 
         `distinct_ip_by_linked_id` and `distinct_visitor_id_by_linked_id` will
         be omitted 
 
-        if the number of `events` for the visitor Id in the last 24
+        if the number of `events` for the visitor ID in the last 24
 
         hours (`events.['24_hours']`) is higher than 20.000.
 
 
         All will not necessarily be returned in a response, some may be omitted

`fingerprint-server-api-v4.yaml`

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

Added elements (0)

None

Removed elements (0)

None

Modified elements (9)

/components/schemas/BundleId/description
/components/schemas/EnvironmentId/description
/components/schemas/LinkedId/description
/components/schemas/Velocity/description
/components/schemas/VelocityData/description
/paths/~1events/get/parameters/13/description
/paths/~1events~1{event_id}/get/responses/400/description
/paths/~1events~1{event_id}/get/responses/404/description
/paths/~1events~1{event_id}/patch/responses/404/description

Changed lines patch

--- a/schemas/fingerprint-server-api-v4.yaml
+++ b/schemas/fingerprint-server-api-v4.yaml
@@ -84,11 +84,11 @@
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Event'
         '400':
-          description: Bad request. The event Id provided is not valid.
+          description: Bad request. The event ID provided is not valid.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '403':
@@ -96,11 +96,11 @@
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '404':
-          description: Not found. The event Id cannot be found in this workspace's data.
+          description: Not found. The event ID cannot be found in this workspace's data.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '429':
@@ -186,11 +186,11 @@
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '404':
-          description: Not found. The event Id cannot be found in this workspace's data.
+          description: Not found. The event ID cannot be found in this workspace's data.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
         '409':
@@ -490,13 +490,13 @@
           description: >
             Filter events by your custom identifier.
 
 
             You can use [linked
-            Ids](https://docs.fingerprint.com/reference/js-agent-get-function#linkedid)
+            IDs](https://docs.fingerprint.com/reference/js-agent-get-function#linkedid)
             to associate identification requests with your own identifier, for
-            example, session Id, purchase Id, or transaction Id. You can then
+            example, session ID, purchase ID, or transaction ID. You can then
             use this `linked_id` parameter to retrieve all events associated
             with your custom identifier.
         - name: url
           in: query
           schema:
@@ -1153,11 +1153,11 @@
   schemas:
     LinkedId:
       type: string
       examples:
         - somelinkedId
-      description: A customer-provided id that was sent with the request.
+      description: A customer-provided ID that was sent with the request.
     Tags:
       type: object
       description: >-
         A customer-provided value or an object that was sent with the
         identification request or updated later.
@@ -1707,11 +1707,11 @@
         - completed
     EnvironmentId:
       type: string
       examples:
         - ae_47abaca3db2c7c43
-      description: Environment Id of the event.
+      description: Environment ID of the event.
     Suspect:
       type: boolean
       description: >-
         Field is `true` if you have previously set the `suspect` flag for this
         event using the [Server API Update event
@@ -1892,11 +1892,11 @@
     BundleId:
       type: string
       examples:
         - com.foo.app
       description: >
-        Bundle Id of the iOS application integrated with the Fingerprint SDK for
+        Bundle ID of the iOS application integrated with the Fingerprint SDK for
         the event.
     PackageName:
       type: string
       examples:
         - com.foo.app
@@ -2414,11 +2414,11 @@
             DolphinAnty, OctoBrowser, and GoLogin.
     VelocityData:
       type: object
       description: >
         Is absent if the velocity data could not be generated for the visitor
-        Id.
+        ID.
       required:
         - 5_minutes
         - 1_hour
       properties:
         5_minutes:
@@ -2449,34 +2449,34 @@
         `linked_id` at three distinct time
 
         intervals: 5 minutes, 1 hour, and 24 hours as follows: 
 
 
-        - Number of distinct IP addresses associated to the visitor Id.
+        - Number of distinct IP addresses associated to the visitor ID.
 
-        - Number of distinct linked Ids associated with the visitor Id.
+        - Number of distinct linked IDs associated with the visitor ID.
 
-        - Number of distinct countries associated with the visitor Id.
+        - Number of distinct countries associated with the visitor ID.
 
-        - Number of identification events associated with the visitor Id.
+        - Number of identification events associated with the visitor ID.
 
         - Number of identification events associated with the detected IP
         address.
 
         - Number of distinct IP addresses associated with the provided linked
-        Id.
+        ID.
 
-        - Number of distinct visitor Ids associated with the provided linked Id.
+        - Number of distinct visitor IDs associated with the provided linked ID.
 
 
         The `24_hours` interval of `distinct_ip`, `distinct_linked_id`,
         `distinct_country`,
 
         `distinct_ip_by_linked_id` and `distinct_visitor_id_by_linked_id` will
         be omitted 
 
-        if the number of `events` for the visitor Id in the last 24
+        if the number of `events` for the visitor ID in the last 24
 
         hours (`events.['24_hours']`) is higher than 20.000.
 
 
         All will not necessarily be returned in a response, some may be omitted

github-actions · 2026-09-07T10:05:02Z

⚠️ 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.

fingerprint-dx-team-actions-runner Bot requested a review from a team as a code owner September 7, 2026 09:50

fingerprint-dx-team-actions-runner Bot deployed to test September 7, 2026 09:50 Active

chore(release): changeset created a new release

28e54f9

fingerprint-dx-team-actions-runner Bot force-pushed the changeset-release/main branch from 2599de8 to 28e54f9 Compare September 7, 2026 10:04

fingerprint-dx-team-actions-runner Bot deployed to test September 7, 2026 10:04 Active

JuroUhlar approved these changes Sep 7, 2026

View reviewed changes

JuroUhlar merged commit 15f687e into main Sep 7, 2026
7 checks passed

JuroUhlar deleted the changeset-release/main branch September 7, 2026 10:44

Navigation Menu

Repository navigation

Release [changeset] - #472

Release [changeset]#472
JuroUhlar merged 1 commit into
mainfrom
changeset-release/main

fingerprint-dx-team-actions-runner Bot commented Sep 7, 2026

Uh oh!

github-actions Bot commented Sep 7, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 7, 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 Sep 7, 2026

Releases

fingerprint-pro-server-api-openapi@3.7.1

Patch Changes

Uh oh!

github-actions Bot commented Sep 7, 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!

github-actions Bot commented Sep 7, 2026

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

github-actions Bot commented Sep 7, 2026 •

edited

Loading

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

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

`fingerprint-server-api-v4.yaml`