Skip to content

Commit 3fc1b91

Browse files
committed
chore: use normalized v4 schema
Switch sync.sh to use the normalized Server API v4 schema instead of the original schema. Related-Task: INTER-1795
1 parent 3a0c41e commit 3fc1b91

2 files changed

Lines changed: 23 additions & 49 deletions

File tree

res/fingerprint-server-api.yaml

Lines changed: 22 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -302,11 +302,11 @@ paths:
302302
in: query
303303
schema:
304304
type: string
305-
description: >
306-
Filter events by the ASN associated with the event's IP address.
305+
description: >
306+
Filter events by the ASN associated with the event's IP address.
307307
308-
This corresponds to the `ip_info.(v4|v6).asn` property in the
309-
response.
308+
This corresponds to the `ip_info.(v4|v6).asn` property in the
309+
response.
310310
- name: linked_id
311311
in: query
312312
schema:
@@ -805,7 +805,6 @@ components:
805805
endpoint](https://dev.fingerprint.com/reference/updateevent).
806806
Integration:
807807
type: object
808-
additionalProperties: false
809808
properties:
810809
name:
811810
type: string
@@ -815,7 +814,6 @@ components:
815814
description: The version of the specific integration, e.g. "3.11.10".
816815
subintegration:
817816
type: object
818-
additionalProperties: false
819817
properties:
820818
name:
821819
type: string
@@ -826,7 +824,6 @@ components:
826824
SDK:
827825
type: object
828826
description: Contains information about the SDK used to perform the request.
829-
additionalProperties: false
830827
required:
831828
- platform
832829
- version
@@ -858,7 +855,6 @@ components:
858855
description: The rule(s) associated with triggering the webhook via rule engine.
859856
items:
860857
type: object
861-
additionalProperties: false
862858
required:
863859
- id
864860
- name
@@ -872,7 +868,6 @@ components:
872868
type: string
873869
IdentificationConfidence:
874870
type: object
875-
additionalProperties: false
876871
required:
877872
- score
878873
properties:
@@ -894,7 +889,6 @@ components:
894889
type: string
895890
Identification:
896891
type: object
897-
additionalProperties: false
898892
required:
899893
- visitor_id
900894
- visitor_found
@@ -925,7 +919,6 @@ components:
925919
Corresponding to Wed Sep 17 2025 00:41:46 GMT+0000
926920
SupplementaryIDHighRecall:
927921
type: object
928-
additionalProperties: false
929922
description: >-
930923
A supplementary browser identifier that prioritizes coverage over
931924
precision. The High Recall ID algorithm matches more generously, i.e.,
@@ -966,7 +959,6 @@ components:
966959
description: >-
967960
A customer-provided value or an object that was sent with the
968961
identification request or updated later.
969-
additionalProperties: true
970962
Url:
971963
type: string
972964
description: >
@@ -1000,7 +992,6 @@ components:
1000992
`https://example.com/blog/my-article`
1001993
BrowserDetails:
1002994
type: object
1003-
additionalProperties: false
1004995
required:
1005996
- browser_name
1006997
- browser_full_version
@@ -1026,7 +1017,6 @@ components:
10261017
description: >
10271018
Proximity ID represents a fixed geographical zone in a discrete global
10281019
grid within which the device is observed.
1029-
additionalProperties: false
10301020
required:
10311021
- id
10321022
- precision_radius
@@ -1079,7 +1069,6 @@ components:
10791069
BotInfo:
10801070
type: object
10811071
description: Extended bot information.
1082-
additionalProperties: false
10831072
required:
10841073
- category
10851074
- provider
@@ -1163,7 +1152,6 @@ components:
11631152
* `false` - No signs of Frida or the client is not a mobile device.
11641153
IPBlockList:
11651154
type: object
1166-
additionalProperties: false
11671155
properties:
11681156
email_spam:
11691157
type: boolean
@@ -1176,7 +1164,6 @@ components:
11761164
description: IP address was part of known TOR network activity.
11771165
Geolocation:
11781166
type: object
1179-
additionalProperties: false
11801167
properties:
11811168
accuracy_radius:
11821169
type: integer
@@ -1217,7 +1204,6 @@ components:
12171204
type: array
12181205
items:
12191206
type: object
1220-
additionalProperties: false
12211207
required:
12221208
- iso_code
12231209
- name
@@ -1228,7 +1214,6 @@ components:
12281214
type: string
12291215
IPInfoV4:
12301216
type: object
1231-
additionalProperties: false
12321217
required:
12331218
- address
12341219
properties:
@@ -1251,7 +1236,6 @@ components:
12511236
type: string
12521237
IPInfoV6:
12531238
type: object
1254-
additionalProperties: false
12551239
required:
12561240
- address
12571241
properties:
@@ -1277,7 +1261,6 @@ components:
12771261
description: >-
12781262
Details about the request IP address. Has separate fields for v4 and v6
12791263
IP address versions.
1280-
additionalProperties: false
12811264
properties:
12821265
v4:
12831266
$ref: '#/components/schemas/IPInfoV4'
@@ -1300,7 +1283,6 @@ components:
13001283
"high".
13011284
ProxyDetails:
13021285
type: object
1303-
additionalProperties: false
13041286
description: Proxy detection details (present if `proxy` is `true`)
13051287
required:
13061288
- proxy_type
@@ -1467,21 +1449,31 @@ components:
14671449
parameter is specified.
14681450
required:
14691451
- ruleset_id
1452+
- type
14701453
properties:
14711454
ruleset_id:
14721455
$ref: '#/components/schemas/RulesetId'
14731456
rule_id:
14741457
$ref: '#/components/schemas/RuleId'
14751458
rule_expression:
14761459
$ref: '#/components/schemas/RuleExpression'
1477-
oneOf:
1478-
- $ref: '#/components/schemas/EventRuleActionAllow'
1479-
- $ref: '#/components/schemas/EventRuleActionBlock'
1480-
discriminator:
1481-
propertyName: type
1482-
mapping:
1483-
allow: EventRuleActionAllow.yaml
1484-
block: EventRuleActionBlock.yaml
1460+
type:
1461+
$ref: '#/components/schemas/RuleActionType'
1462+
enum:
1463+
- allow
1464+
- block
1465+
request_header_modifications:
1466+
$ref: '#/components/schemas/RequestHeaderModifications'
1467+
status_code:
1468+
$ref: '#/components/schemas/StatusCode'
1469+
headers:
1470+
type: array
1471+
description: A list of headers to send.
1472+
items:
1473+
$ref: '#/components/schemas/RuleActionHeaderField'
1474+
body:
1475+
$ref: '#/components/schemas/RuleActionBody'
1476+
additionalProperties: false
14851477
SuspectScore:
14861478
type: integer
14871479
description: >
@@ -1499,7 +1491,6 @@ components:
14991491
* The browser signature resembles an "anti-detect" browser specifically designed to evade fingerprinting (see `tampering_details.anti_detect_browser`).
15001492
TamperingDetails:
15011493
type: object
1502-
additionalProperties: false
15031494
properties:
15041495
anomaly_score:
15051496
type: number
@@ -1527,7 +1518,6 @@ components:
15271518
description: >
15281519
Is absent if the velocity data could not be generated for the visitor
15291520
Id.
1530-
additionalProperties: false
15311521
required:
15321522
- 5_minutes
15331523
- 1_hour
@@ -1591,7 +1581,6 @@ components:
15911581
if the
15921582
15931583
associated event does not have the required data, such as a linked_id.
1594-
additionalProperties: false
15951584
properties:
15961585
distinct_ip:
15971586
$ref: '#/components/schemas/VelocityData'
@@ -1637,7 +1626,6 @@ components:
16371626
format or unknown).
16381627
VpnMethods:
16391628
type: object
1640-
additionalProperties: false
16411629
properties:
16421630
timezone_mismatch:
16431631
type: boolean
@@ -1703,7 +1691,6 @@ components:
17031691
Baseline measurement of canonical fonts rendered on the device. Numeric
17041692
width metrics, in CSS pixels, for the canonical fonts collected by the
17051693
agent.
1706-
additionalProperties: false
17071694
properties:
17081695
default:
17091696
type: number
@@ -1729,7 +1716,6 @@ components:
17291716
Emoji:
17301717
type: object
17311718
description: Bounding box metrics describing how the emoji glyph renders.
1732-
additionalProperties: false
17331719
properties:
17341720
font:
17351721
type: string
@@ -1780,7 +1766,6 @@ components:
17801766
Canvas:
17811767
type: object
17821768
description: Canvas fingerprint containing winding flag plus geometry/text hashes.
1783-
additionalProperties: false
17841769
properties:
17851770
winding:
17861771
type: boolean
@@ -1803,7 +1788,6 @@ components:
18031788
WebGlExtensions:
18041789
type: object
18051790
description: Hashes of WebGL context attributes and extension support.
1806-
additionalProperties: false
18071791
properties:
18081792
context_attributes:
18091793
type: string
@@ -1822,7 +1806,6 @@ components:
18221806
WebGlBasics:
18231807
type: object
18241808
description: Render and vendor strings reported by the WebGL context.
1825-
additionalProperties: false
18261809
properties:
18271810
version:
18281811
type: string
@@ -1847,7 +1830,6 @@ components:
18471830
TouchSupport:
18481831
type: object
18491832
description: Browser-reported touch capabilities.
1850-
additionalProperties: false
18511833
properties:
18521834
touch_event:
18531835
type: boolean
@@ -1910,7 +1892,6 @@ components:
19101892
description: Browser plugins reported by `navigator.plugins`.
19111893
items:
19121894
type: object
1913-
additionalProperties: false
19141895
properties:
19151896
name:
19161897
type: string
@@ -1920,7 +1901,6 @@ components:
19201901
type: array
19211902
items:
19221903
type: object
1923-
additionalProperties: false
19241904
properties:
19251905
type:
19261906
type: string
@@ -1942,7 +1922,6 @@ components:
19421922
A curated subset of raw browser/device attributes that the API surface
19431923
exposes. Each property contains a value or object with the data for the
19441924
collected signal.
1945-
additionalProperties: false
19461925
properties:
19471926
font_preferences:
19481927
$ref: '#/components/schemas/FontPreferences'
@@ -1999,7 +1978,6 @@ components:
19991978
description: >-
20001979
Contains results from Fingerprint Identification and all active Smart
20011980
Signals.
2002-
additionalProperties: false
20031981
required:
20041982
- event_id
20051983
- timestamp
@@ -2337,7 +2315,6 @@ components:
23372315
existed or it has been deleted.
23382316
Error:
23392317
type: object
2340-
additionalProperties: false
23412318
required:
23422319
- code
23432320
- message
@@ -2348,7 +2325,6 @@ components:
23482325
type: string
23492326
ErrorResponse:
23502327
type: object
2351-
additionalProperties: false
23522328
required:
23532329
- error
23542330
properties:
@@ -2365,7 +2341,6 @@ components:
23652341
description: >-
23662342
A customer-provided value or an object that was sent with the
23672343
identification request or updated later.
2368-
additionalProperties: true
23692344
suspect:
23702345
type: boolean
23712346
description: Suspect flag indicating observed suspicious or fraudulent event
@@ -2375,7 +2350,6 @@ components:
23752350
description: >-
23762351
Contains a list of all identification events matching the specified
23772352
search criteria.
2378-
additionalProperties: false
23792353
required:
23802354
- events
23812355
properties:

sync.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
set -euo pipefail
33

44
defaultBaseUrl="https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi"
5-
schemaUrl="${1:-$defaultBaseUrl/schemas/fingerprint-server-api-v4.yaml}"
5+
schemaUrl="${1:-$defaultBaseUrl/schemas/fingerprint-server-api-v4-normalized.yaml}"
66
examplesBaseUrl="${2:-$defaultBaseUrl/examples}"
77

88
mkdir -p ./res

0 commit comments

Comments
 (0)