Skip to content

Commit ad4beba

Browse files
ilfailfa
authored
Merge pull request #168 from fingerprintjs/changeset-release/main
Release [changeset]
2 parents ec58af1 + 25dca6b commit ad4beba

9 files changed

+127
-140
lines changed

‎.changeset/changesets-chatty-pandas-call.zip

3.69 KB
Binary file not shown.

‎.changeset/fuzzy-apes-talk.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎.changeset/khaki-results-help.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎.changeset/large-lights-push.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎.changeset/quiet-parrots-stick.md

Lines changed: 0 additions & 65 deletions
This file was deleted.

‎.changeset/short-icons-wish.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎.changeset/tender-bottles-kneel.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎CHANGELOG.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,131 @@
11
# fingerprint-pro-server-api-openapi
22

3+
## 2.0.0
4+
5+
### Major Changes
6+
7+
- - Remove the `BrowserDetails` field `botProbability`.
8+
- Update the `IdentificationConfidence` field `score` type format: `float` -> `double`.
9+
- Make the `RawDeviceAttributeError` field `name` **optional** .
10+
- Make the `RawDeviceAttributeError` field `message` **optional** .
11+
- **events**: Remove the `EventsResponse` field `error`.
12+
- [note]: The errors are represented by `ErrorResponse` model.
13+
- **events**: Update the `HighActivity` field `dailyRequests` type format: `number` -> `int64`.
14+
- **events**: Specify the `Tampering` field `anomalyScore` type format: `double`.
15+
- **webhook**: Make the `Webhook` fields **optional**: `visitorId`, `visitorFound`, `firstSeenAt`, `lastSeenAt`, `browserDetails`, `incognito`.
16+
- **webhook**: Make the `WebhookClonedApp` field `result` **optional**.
17+
- **webhook**: Make the `WebhookDeveloperTools` field `result` **optional**.
18+
- **webhook**: Make the `WebhookEmulator` field `result` **optional**.
19+
- **webhook**: Make the `WebhookFactoryReset` fields `time` and `timestamp` **optional**.
20+
- **webhook**: Make the `WebhookFrida` field `result` **optional**.
21+
- **webhook**: Update the `WebhookHighActivity` field `dailyRequests` type format: `number` -> `int64`.
22+
- **webhook**: Make the `WebhookIPBlocklist` fields `result` and `details` **optional**.
23+
- **webhook**: Make the `WebhookJailbroken` field `result` **optional**.
24+
- **webhook**: Make the `WebhookLocationSpoofing` field `result` **optional**.
25+
- **webhook**: Make the `WebhookPrivacySettings` field `result` **optional**.
26+
- **webhook**: Make the `WebhookProxy` field `result` **optional**.
27+
- **webhook**: Make the `WebhookRemoteControl` field `result` **optional**.
28+
- **webhook**: Make the `WebhookRootApps` field `result` **optional**.
29+
- **webhook**: Make the `WebhookSuspectScore` field `result` **optional**.
30+
- **webhook**: Make the `WebhookTampering` fields `result`, `anomalyScore` and `antiDetectBrowser` **optional**.
31+
- **webhook**: Specify the `WebhookTampering` field `anomalyScore` type format: `double`.
32+
- **webhook**: Make the `WebhookTor` field `result` **optional**.
33+
- **webhook**: Make the `WebhookVelocity` fields **optional**: `distinctIp`, `distinctLinkedId`, `distinctCountry`, `events`, `ipEvents`, `distinctIpByLinkedId`, `distinctVisitorIdByLinkedId`.
34+
- **webhook**: Make the `WebhookVirtualMachine` field `result` **optional**.
35+
- **webhook**: Make the `WebhookVPN` fields **optional**: `result`, `confidence`, `originTimezone`, `methods`. ([5205383](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/commit/52053838050364bec51a1517ac21f5024fc9b709))
36+
- - Rename `BotdResult` -> `Botd`.
37+
- Rename `BotdDetectionResult` -> `BotdBot`:
38+
- Extract `result` type as `BotdBotResult`.
39+
- Rename `ClonedAppResult` -> `ClonedApp`.
40+
- Rename `DeveloperToolsResult` -> `DeveloperTools`.
41+
- Rename `EmulatorResult` -> `Emulator`.
42+
- Refactor error models:
43+
- Remove `ErrorCommon403Response`, `ErrorCommon429Response`, `ErrorEvent404Response`, `TooManyRequestsResponse`, `ErrorVisits403`, `ErrorUpdateEvent400Response`, `ErrorUpdateEvent409Response`, `ErrorVisitor400Response`, `ErrorVisitor404Response`, `IdentificationError`, `ProductError`.
44+
- Introduce `ErrorResponse` and `ErrorPlainResponse`.
45+
- [note]: `ErrorPlainResponse` has a different format `{ "error": string }` and it is used only in `GET /visitors`.
46+
- Extract `error` type as `Error`.
47+
- Extract `error.code` type as `ErrorCode`.
48+
- Rename `EventResponse` -> `EventsGetResponse`.
49+
- Rename `EventUpdateRequest` -> `EventsUpdateRequest`.
50+
- Rename `FactoryResetResult` -> `FactoryReset`.
51+
- Rename `FridaResult` -> `Frida`.
52+
- Rename `IPLocation` -> `Geolocation`:
53+
- Rename `IPLocationCity` -> `GeolocationCity`.
54+
- Extract `subdivisions` type as `GeolocationSubdivisions`.
55+
- Rename `Location` -> `GeolocationContinent`:
56+
- Introduce a dedicated type `GeolocationCountry`.
57+
- Rename `Subdivision` -> `GeolocationSubdivision`.
58+
- Rename `HighActivityResult` -> `HighActivity`.
59+
- Rename `Confidence` -> `IdentificationConfidence`.
60+
- Rename `SeenAt` -> `IdentificationSeenAt`.
61+
- Rename `IncognitoResult` -> `Incognito`.
62+
- Rename `IpBlockListResult` -> `IPBlocklist`:
63+
- Extract `details` type as `IPBlocklistDetails`.
64+
- Rename `IpInfoResult` -> `IPInfo`:
65+
- Rename `IpInfoResultV4` -> `IPInfoV4`.
66+
- Rename `IpInfoResultV6` -> `IPInfoV6`.
67+
- Rename `ASN` -> `IPInfoASN`.
68+
- Rename `DataCenter` -> `IPInfoDataCenter`.
69+
- Rename `JailbrokenResult` -> `Jailbroken`.
70+
- Rename `LocationSpoofingResult` -> `LocationSpoofing`.
71+
- Rename `PrivacySettingsResult` -> `PrivacySettings`.
72+
- Rename `ProductsResponse` -> `Products`:
73+
- Rename inner types: `ProductsResponseIdentification` -> `ProductIdentification`, `ProductsResponseIdentificationData` -> `Identification`, `ProductsResponseBotd` -> `ProductBotd`, `SignalResponseRootApps` -> `ProductRootApps`, `SignalResponseEmulator` -> `ProductEmulator`, `SignalResponseIpInfo` -> `ProductIPInfo`, `SignalResponseIpBlocklist` -> `ProductIPBlocklist`, `SignalResponseTor` -> `ProductTor`, `SignalResponseVpn` -> `ProductVPN`, `SignalResponseProxy` -> `ProductProxy`, `ProxyResult` -> `Proxy`, `SignalResponseIncognito` -> `ProductIncognito`, `SignalResponseTampering` -> `ProductTampering`, `SignalResponseClonedApp` -> `ProductClonedApp`, `SignalResponseFactoryReset` -> `ProductFactoryReset`, `SignalResponseJailbroken` -> `ProductJailbroken`, `SignalResponseFrida` -> `ProductFrida`, `SignalResponsePrivacySettings` -> `ProductPrivacySettings`, `SignalResponseVirtualMachine` -> `ProductVirtualMachine`, `SignalResponseRawDeviceAttributes` -> `ProductRawDeviceAttributes`, `RawDeviceAttributesResultValue` -> `RawDeviceAttributes`, `SignalResponseHighActivity` -> `ProductHighActivity`, `SignalResponseLocationSpoofing` -> `ProductLocationSpoofing`, `SignalResponseSuspectScore` -> `ProductSuspectScore`, `SignalResponseRemoteControl` -> `ProductRemoteControl`, `SignalResponseVelocity` -> `ProductVelocity`, `SignalResponseDeveloperTools` -> `ProductDeveloperTools`.
74+
- Extract `identification.data` type as `Identification`.
75+
- Rename `RawDeviceAttributesResult` -> `RawDeviceAttributes`:
76+
- Extract item type as `RawDeviceAttribute`.
77+
- Extract `error` type as `RawDeviceAttributeError`.
78+
- Rename `RemoteControlResult` -> `RemoteControl`.
79+
- Rename `RootAppsResult` -> `RootApps`.
80+
- Rename `SuspectScoreResult` -> `SuspectScore`.
81+
- Extract new model `Tag`.
82+
- Rename `TamperingResult` -> `Tampering`.
83+
- Rename `TorResult` -> `Tor`.
84+
- Rename `VelocityResult` -> `Velocity`:
85+
- Rename `VelocityIntervals` -> `VelocityData`.
86+
- Rename `VelocityIntervalResult` -> `VelocityIntervals`.
87+
- Rename `VirtualMachineResult` -> `VirtualMachine`.
88+
- Rename the `Visit` field `ipLocation` type `DeprecatedIPLocation` -> `DeprecatedGeolocation`.
89+
- Instead of `DeprecatedIPLocationCity` use common `GeolocationCity`
90+
- Rename `Response` -> `VisitorsGetResponse`.
91+
- Omit extra inner type `ResponseVisits`
92+
- Rename `VpnResult` -> `VPN`.
93+
- Extract `confidence` type as `VPNConfidence`.
94+
- Extract `methods` type as `VPNMethods`.
95+
- Rename `WebhookVisit` -> `Webhook`.
96+
- Introduce new inner types: `WebhookRootApps`, `WebhookEmulator`, `WebhookIPInfo`, `WebhookIPBlocklist`, `WebhookTor`, `WebhookVPN`, `WebhookProxy`, `WebhookTampering`, `WebhookClonedApp`, `WebhookFactoryReset`, `WebhookJailbroken`, `WebhookFrida`, `WebhookPrivacySettings`, `WebhookVirtualMachine`, `WebhookRawDeviceAttributes`, `WebhookHighActivity`, `WebhookLocationSpoofing`, `WebhookSuspectScore`, `WebhookRemoteControl`, `WebhookVelocity`, `WebhookDeveloperTools`. ([aa869ec](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/commit/aa869ece12f90956d9cfb86dcc7e2ab754325c48))
97+
98+
### Minor Changes
99+
100+
- Added new `ipEvents`, `distinctIpByLinkedId`, and `distinctVisitorIdByLinkedId` fields to the `velocity` Smart Signal. ([02dc195](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/commit/02dc195c58f636b5a42017b0decba55671a286f5))
101+
- - Make the `GeolocationCity` field `name` **required**.
102+
- Make the `GeolocationSubdivision` field `isoCode` **required**.
103+
- Make the `GeolocationSubdivision` field `name` **required**.
104+
- Make the `IPInfoASN` field `name` **required** .
105+
- Make the `IPInfoDataCenter` field `name` **required**.
106+
- Add **optional** `IdentificationConfidence` field `comment`.
107+
- **events**: Add **optional** `Botd` field `meta`.
108+
- **events**: Add **optional** `Identification` field `components`.
109+
- **events**: Make the `VPN` field `originCountry` **required**.
110+
- **visitors**: Add **optional** `Visit` field `components`.
111+
- **webhook**: Add **optional** `Webhook` field `components`. ([5205383](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/commit/52053838050364bec51a1517ac21f5024fc9b709))
112+
113+
### Patch Changes
114+
115+
- - Fix descriptions formatting:
116+
- Remove extra line breaks.
117+
- Fix block styles.
118+
- Fix links in descriptions. ([202d335](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/commit/202d335c773bbf6c677fd32b66f4c5cde64b6792))
119+
- - Remove all `example` YAML attributes from all the properties due to [deprecation](https://spec.openapis.org/oas/v3.1.0#fixed-fields-19).
120+
- Keep using JSON Schema `examples` with the `externalValue` associated with JSON example from `/schemas/paths/examples`.
121+
- Reorder all the `schemas` fields (e.g. `type` -> `format` -> `description` -> `required` -> `properties`).
122+
- Reorder all the `paths` fields (e.g. `tags` -> `summary` -> `description` -> `parameters` -> ...)
123+
- Reorder all the object properties in the order they returned by API.
124+
- Move existing and add new error examples to `/schemas/paths/examples/errors`.
125+
- Replace GET /events TooManyRequests examples with a single `get_event_200_too_many_requests_error.json`.
126+
- Update `products.identification.error.message` in `get_event_200_<...>.json` examples.
127+
- Rename GET /visitors example files. ([aa869ec](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/commit/aa869ece12f90956d9cfb86dcc7e2ab754325c48))
128+
3129
## 1.3.1
4130

5131
### Patch Changes

0 commit comments

Comments
 (0)