Sync OpenAPI Schema (17494) by fingerprint-dx-team-actions-runner[bot] · Pull Request #386 · fingerprintjs/fingerprint-pro-server-api-openapi

fingerprint-dx-team-actions-runner · 2026-05-29T15:53:23Z

This PR automatically updates the OpenAPI schema.

Changes

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

Modified files

schemas/components/schemas/EdgeResponse.yaml
schemas/paths/edge.yaml
schemas/paths/events.yaml
schemas/paths/examples/edge/analyze_200.json
schemas/paths/examples/edge/analyze_200_non_bot.json

Added files

schemas/paths/examples/edge/analyze_200_proxy.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-05-29T15:53:28Z

⚠️The changes are not finalized yet. Do not merge this PR until the changes are ready.

changeset-bot · 2026-05-29T15:53:28Z

⚠️ No Changeset found

Latest commit: c97e016

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 · 2026-05-29T15:53:52Z

Schema Diff vs Published Schemas

Generated at: 2026-06-19T09:43:57.968Z
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: +4 added, -0 removed, ~4 modified

Added elements (4)

/paths/~1events/get/parameters/11/schema/items
/paths/~1events/get/parameters/11/style
/paths/~1events/get/parameters/13/schema/items
/paths/~1events/get/parameters/13/style

Removed elements (0)

None

Modified elements (4)

/paths/~1events/get/parameters/11/description
/paths/~1events/get/parameters/11/schema/type
/paths/~1events/get/parameters/13/description
/paths/~1events/get/parameters/13/schema/type

Changed lines patch

--- a/schemas/fingerprint-server-api-v4-normalized.yaml
+++ b/schemas/fingerprint-server-api-v4-normalized.yaml
@@ -413,18 +413,28 @@
             will match events with a Bot Info Name of `ChatGPT Agent` or
             `Bedrock AgentCore`. Other notations like comma-separated or bracket
             notation are not supported.
         - name: ip_address
           in: query
+          style: form
           schema:
-            type: string
+            type: array
+            items:
+              type: string
           description: >
             Filter events by IP address or IP range (if CIDR notation is used).
             If CIDR notation is not used, a /32 for IPv4 or /128 for IPv6 is
             assumed.
 
             Examples of range based queries: 10.0.0.0/24, 192.168.0.1/32
+
+
+            Multiple IP addresses can be provided using the repeated keys
+            syntax. For example,
+            `ip_address=192.168.0.1&ip_address=10.0.0.0/24`, will match events
+            with either IP address or range. Other notations like
+            comma-separated or bracket notation are not supported.
         - name: asn
           in: query
           schema:
             type: string
           description: >
@@ -432,22 +442,32 @@
 
             This corresponds to the `ip_info.(v4|v6).asn` property in the
             response.
         - name: linked_id
           in: query
+          style: form
           schema:
-            type: string
+            type: array
+            items:
+              type: string
           description: >
             Filter events by your custom identifier.
 
 
             You can use [linked
             Ids](https://docs.fingerprint.com/reference/js-agent-v4-get-function#linkedid)
             to associate identification requests with your own identifier, for
             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.
+
+
+            Multiple linked Ids can be provided using the repeated keys syntax.
+            For example, `linked_id=session-1&linked_id=session-2`, will match
+            events with a linked Id of `session-1` or `session-2`. Other
+            notations like comma-separated or bracket notation are not
+            supported.
         - name: url
           in: query
           schema:
             type: string
           description: |

`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: +4 added, -0 removed, ~4 modified

Added elements (4)

/paths/~1events/get/parameters/11/schema/items
/paths/~1events/get/parameters/11/style
/paths/~1events/get/parameters/13/schema/items
/paths/~1events/get/parameters/13/style

Removed elements (0)

None

Modified elements (4)

/paths/~1events/get/parameters/11/description
/paths/~1events/get/parameters/11/schema/type
/paths/~1events/get/parameters/13/description
/paths/~1events/get/parameters/13/schema/type

Changed lines patch

--- a/schemas/fingerprint-server-api-v4-with-examples.yaml
+++ b/schemas/fingerprint-server-api-v4-with-examples.yaml
@@ -1514,18 +1514,28 @@
             will match events with a Bot Info Name of `ChatGPT Agent` or
             `Bedrock AgentCore`. Other notations like comma-separated or bracket
             notation are not supported.
         - name: ip_address
           in: query
+          style: form
           schema:
-            type: string
+            type: array
+            items:
+              type: string
           description: >
             Filter events by IP address or IP range (if CIDR notation is used).
             If CIDR notation is not used, a /32 for IPv4 or /128 for IPv6 is
             assumed.
 
             Examples of range based queries: 10.0.0.0/24, 192.168.0.1/32
+
+
+            Multiple IP addresses can be provided using the repeated keys
+            syntax. For example,
+            `ip_address=192.168.0.1&ip_address=10.0.0.0/24`, will match events
+            with either IP address or range. Other notations like
+            comma-separated or bracket notation are not supported.
         - name: asn
           in: query
           schema:
             type: string
           description: >
@@ -1533,22 +1543,32 @@
 
             This corresponds to the `ip_info.(v4|v6).asn` property in the
             response.
         - name: linked_id
           in: query
+          style: form
           schema:
-            type: string
+            type: array
+            items:
+              type: string
           description: >
             Filter events by your custom identifier.
 
 
             You can use [linked
             Ids](https://docs.fingerprint.com/reference/js-agent-v4-get-function#linkedid)
             to associate identification requests with your own identifier, for
             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.
+
+
+            Multiple linked Ids can be provided using the repeated keys syntax.
+            For example, `linked_id=session-1&linked_id=session-2`, will match
+            events with a linked Id of `session-1` or `session-2`. Other
+            notations like comma-separated or bracket notation are not
+            supported.
         - name: url
           in: query
           schema:
             type: string
           description: |

`fingerprint-server-api-v4.yaml`

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

Added elements (4)

/paths/~1events/get/parameters/11/schema/items
/paths/~1events/get/parameters/11/style
/paths/~1events/get/parameters/13/schema/items
/paths/~1events/get/parameters/13/style

Removed elements (0)

None

Modified elements (4)

/paths/~1events/get/parameters/11/description
/paths/~1events/get/parameters/11/schema/type
/paths/~1events/get/parameters/13/description
/paths/~1events/get/parameters/13/schema/type

Changed lines patch

--- a/schemas/fingerprint-server-api-v4.yaml
+++ b/schemas/fingerprint-server-api-v4.yaml
@@ -413,18 +413,28 @@
             will match events with a Bot Info Name of `ChatGPT Agent` or
             `Bedrock AgentCore`. Other notations like comma-separated or bracket
             notation are not supported.
         - name: ip_address
           in: query
+          style: form
           schema:
-            type: string
+            type: array
+            items:
+              type: string
           description: >
             Filter events by IP address or IP range (if CIDR notation is used).
             If CIDR notation is not used, a /32 for IPv4 or /128 for IPv6 is
             assumed.
 
             Examples of range based queries: 10.0.0.0/24, 192.168.0.1/32
+
+
+            Multiple IP addresses can be provided using the repeated keys
+            syntax. For example,
+            `ip_address=192.168.0.1&ip_address=10.0.0.0/24`, will match events
+            with either IP address or range. Other notations like
+            comma-separated or bracket notation are not supported.
         - name: asn
           in: query
           schema:
             type: string
           description: >
@@ -432,22 +442,32 @@
 
             This corresponds to the `ip_info.(v4|v6).asn` property in the
             response.
         - name: linked_id
           in: query
+          style: form
           schema:
-            type: string
+            type: array
+            items:
+              type: string
           description: >
             Filter events by your custom identifier.
 
 
             You can use [linked
             Ids](https://docs.fingerprint.com/reference/js-agent-v4-get-function#linkedid)
             to associate identification requests with your own identifier, for
             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.
+
+
+            Multiple linked Ids can be provided using the repeated keys syntax.
+            For example, `linked_id=session-1&linked_id=session-2`, will match
+            events with a linked Id of `session-1` or `session-2`. Other
+            notations like comma-separated or bracket notation are not
+            supported.
         - name: url
           in: query
           schema:
             type: string
           description: |

github-actions · 2026-06-19T09:43:55Z

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

fingerprint-pro-server-api-openapi@3.4.0

Minor Changes

Add proxy, proxy_confidence, proxy_details, vpn, vpn_confidence, and vpn_methods to EdgeResponse (2d4f791)
events: Add battery_level and battery_low_power_mode to RawDeviceAttributes (ba43bc1)
Added VPN mlScore and mlPrediction to v3 events and events search (2d17209)

chore: sync OpenAPI schema

021bcaf

fingerprint-dx-team-actions-runner Bot requested review from JuroUhlar, TheUnderScorer, erayaydin, ilfa and mcnulty-fp as code owners May 29, 2026 15:53

fingerprint-dx-team-actions-runner Bot added the Not Completed label May 29, 2026

fingerprint-dx-team-actions-runner Bot temporarily deployed to test May 29, 2026 15:53 Inactive

Merge branch 'main' into sync-17494

c97e016

erayaydin temporarily deployed to test June 19, 2026 09:43 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sync OpenAPI Schema (17494)#386

Sync OpenAPI Schema (17494)#386
fingerprint-dx-team-actions-runner[bot] wants to merge 2 commits into
mainfrom
sync-17494

fingerprint-dx-team-actions-runner Bot commented May 29, 2026

Uh oh!

fingerprint-dx-team-actions-runner Bot commented May 29, 2026

Uh oh!

changeset-bot Bot commented May 29, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 29, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

fingerprint-dx-team-actions-runner Bot commented May 29, 2026

Changes

Uh oh!

fingerprint-dx-team-actions-runner Bot commented May 29, 2026

Uh oh!

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

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions Bot commented May 29, 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 Jun 19, 2026

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

fingerprint-pro-server-api-openapi@3.4.0

Minor Changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot Bot commented May 29, 2026 •

edited

Loading

github-actions Bot commented May 29, 2026 •

edited

Loading

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

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

`fingerprint-server-api-v4.yaml`