Apply semantic changes

.changeset/khaki-results-help.md

@@ -0,0 +1,15 @@
+---
+'fingerprint-pro-server-api-openapi': minor
+---
+
+- Make the `GeolocationCity` field `name` **required**.
+- Make the `GeolocationSubdivision` field `isoCode` **required**.
+- Make the `GeolocationSubdivision` field `name` **required**.
+- Make the `IPInfoASN` field `name` **required** .
+- Make the `IPInfoDataCenter` field `name` **required**.
+- Add **optional** `IdentificationConfidence` field `comment`.
+- **events**: Add **optional** `Botd` field `meta`.
+- **events**: Add **optional** `Identification` field `components`.
+- **events**: Make the `VPN` field `originCountry` **required**.
+- **visitors**: Add **optional** `Visit` field `components`.
+- **webhook**: Add **optional** `Webhook` field `components`.

.changeset/large-lights-push.md

@@ -0,0 +1,33 @@
+---
+'fingerprint-pro-server-api-openapi': major
+---
+
+- Remove the `BrowserDetails` field `botProbability`.
+- Update the `IdentificationConfidence` field `score` type format: `float` -> `double`.
+- Make the `RawDeviceAttributeError` field `name` **optional** .
+- Make the `RawDeviceAttributeError` field `message` **optional** .
+- **events**: Remove the `EventsResponse` field `error`.
+  - [note]: The errors are represented by `ErrorResponse` model.
+- **events**: Update the `HighActivity` field `dailyRequests` type format: `number` -> `int64`.
+- **events**: Specify the `Tampering` field `anomalyScore` type format: `double`.
+- **webhook**: Make the `Webhook` fields **optional**: `visitorId`, `visitorFound`, `firstSeenAt`, `lastSeenAt`, `browserDetails`, `incognito`.
+- **webhook**: Make the `WebhookClonedApp` field `result` **optional**.
+- **webhook**: Make the `WebhookDeveloperTools` field `result` **optional**.
+- **webhook**: Make the `WebhookEmulator` field `result` **optional**.
+- **webhook**: Make the `WebhookFactoryReset` fields `time` and `timestamp` **optional**.
+- **webhook**: Make the `WebhookFrida` field `result` **optional**.
+- **webhook**: Update the `WebhookHighActivity` field `dailyRequests` type format: `number` -> `int64`.
+- **webhook**: Make the `WebhookIPBlocklist` fields `result` and `details` **optional**.
+- **webhook**: Make the `WebhookJailbroken` field `result` **optional**.
+- **webhook**: Make the `WebhookLocationSpoofing` field `result` **optional**.
+- **webhook**: Make the `WebhookPrivacySettings` field `result` **optional**.
+- **webhook**: Make the `WebhookProxy` field `result` **optional**.
+- **webhook**: Make the `WebhookRemoteControl` field `result` **optional**.
+- **webhook**: Make the `WebhookRootApps` field `result` **optional**.
+- **webhook**: Make the `WebhookSuspectScore` field `result` **optional**.
+- **webhook**: Make the `WebhookTampering` fields `result`, `anomalyScore` and `antiDetectBrowser` **optional**.
+- **webhook**: Specify the `WebhookTampering` field `anomalyScore` type format: `double`.
+- **webhook**: Make the `WebhookTor` field `result` **optional**.
+- **webhook**: Make the `WebhookVelocity` fields **optional**: `distinctIp`, `distinctLinkedId`, `distinctCountry`, `events`, `ipEvents`, `distinctIpByLinkedId`, `distinctVisitorIdByLinkedId`.
+- **webhook**: Make the `WebhookVirtualMachine` field `result` **optional**.
+- **webhook**: Make the `WebhookVPN` fields **optional**: `result`, `confidence`, `originTimezone`, `methods`.

schemas/components/schemas/Botd.yaml

@@ -11,6 +11,8 @@ required:
 properties:
   bot:
     $ref: BotdBot.yaml
+  meta:
+    $ref: Tag.yaml
   linkedId:
     type: string
     description: A customer-provided id that was sent with the request.

schemas/components/schemas/BrowserDetails.yaml

@@ -23,5 +23,3 @@ properties:
     type: string
   userAgent:
     type: string
-  botProbability:
-    type: integer

schemas/components/schemas/EventsGetResponse.yaml

@@ -8,5 +8,3 @@ required:
 properties:
   products:
     $ref: Products.yaml
-  error:
-    $ref: Error.yaml

schemas/components/schemas/GeolocationCity.yaml

@@ -1,5 +1,7 @@
 type: object
 additionalProperties: false
+required:
+  - name
 properties:
   name:
     type: string

schemas/components/schemas/GeolocationSubdivision.yaml

@@ -1,5 +1,8 @@
 type: object
 additionalProperties: false
+required:
+  - isoCode
+  - name
 properties:
   isoCode:
     type: string

schemas/components/schemas/HighActivity.yaml

@@ -7,6 +7,7 @@ properties:
     type: boolean
     description: Flag indicating whether the request came from a high activity visitor.
   dailyRequests:
-    type: number
+    type: integer
+    format: int64
     minimum: 1
     description: Number of requests from the same visitor in the previous day.

schemas/components/schemas/IPInfoASN.yaml

@@ -2,6 +2,7 @@ type: object
 additionalProperties: false
 required:
   - asn
+  - name
   - network
 properties:
   asn:

schemas/components/schemas/IPInfoDataCenter.yaml

@@ -2,6 +2,7 @@ type: object
 additionalProperties: false
 required:
   - result
+  - name
 properties:
   result:
     type: boolean

schemas/components/schemas/Identification.yaml

@@ -61,3 +61,5 @@ properties:
     $ref: IdentificationSeenAt.yaml
   lastSeenAt:
     $ref: IdentificationSeenAt.yaml
+  components:
+    $ref: RawDeviceAttributes.yaml

schemas/components/schemas/IdentificationConfidence.yaml

@@ -5,7 +5,7 @@ required:
 properties:
   score:
     type: number
-    format: float
+    format: double
     minimum: 0
     maximum: 1
     description: >-
@@ -17,3 +17,5 @@ properties:
       The revision name of the method used to calculate the Confidence score.
       This field is only present for customers who opted in to an alternative
       calculation method.
+  comment:
+    type: string

schemas/components/schemas/RawDeviceAttributeError.yaml

@@ -1,8 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - name
-  - message
 properties:
   name:
     type: string

schemas/components/schemas/Tampering.yaml

@@ -13,6 +13,7 @@ properties:
         * The browser signature resembles one of "anti-detect" browsers specifically designed to evade identification and fingerprinting, for example, Incognition (indicated by `antiDetectBrowser`).
   anomalyScore:
     type: number
+    format: double
     minimum: 0
     maximum: 1
     description: >-

schemas/components/schemas/VPN.yaml

@@ -4,6 +4,7 @@ required:
   - result
   - confidence
   - originTimezone
+  - originCountry
   - methods
 properties:
   result:

schemas/components/schemas/Visit.yaml

@@ -55,3 +55,5 @@ properties:
     $ref: IdentificationSeenAt.yaml
   lastSeenAt:
     $ref: IdentificationSeenAt.yaml
+  components:
+    $ref: RawDeviceAttributes.yaml

schemas/components/schemas/Webhook.yaml

@@ -5,12 +5,6 @@ required:
   - ip
   - time
   - timestamp
-  - visitorId
-  - visitorFound
-  - firstSeenAt
-  - lastSeenAt
-  - browserDetails
-  - incognito
 properties:
   requestId:
     type: string
@@ -61,6 +55,8 @@ properties:
     description: Flag if user used incognito session.
   clientReferrer:
     type: string
+  components:
+    $ref: RawDeviceAttributes.yaml
   bot:
     $ref: BotdBot.yaml
   userAgent:

schemas/components/schemas/WebhookClonedApp.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookDeveloperTools.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookEmulator.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookFactoryReset.yaml

@@ -1,8 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - time
-  - timestamp
 properties:
   time:
     type: string

schemas/components/schemas/WebhookFrida.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookHighActivity.yaml

@@ -7,6 +7,7 @@ properties:
     type: boolean
     description: Flag indicating whether the request came from a high activity visitor.
   dailyRequests:
-    type: number
+    type: integer
+    format: int64
     minimum: 1
     description: Number of requests from the same visitor in the previous day.

schemas/components/schemas/WebhookIPBlocklist.yaml

@@ -1,8 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
-  - details
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookJailbroken.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookLocationSpoofing.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookPrivacySettings.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookProxy.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookRemoteControl.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookRootApps.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookSuspectScore.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: integer

schemas/components/schemas/WebhookTampering.yaml

@@ -1,9 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
-  - anomalyScore
-  - antiDetectBrowser
 properties:
   result:
     type: boolean
@@ -13,6 +9,7 @@ properties:
         * The browser signature resembles one of "anti-detect" browsers specifically designed to evade identification and fingerprinting, for example, Incognition (indicated by `antiDetectBrowser`).
   anomalyScore:
     type: number
+    format: double
     minimum: 0
     maximum: 1
     description: >-

schemas/components/schemas/WebhookTor.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookVPN.yaml

@@ -1,10 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
-  - confidence
-  - originTimezone
-  - methods
 properties:
   result:
     type: boolean

schemas/components/schemas/WebhookVelocity.yaml

@@ -16,14 +16,6 @@ description: |
   if the number of `events` for the visitor ID in the last 24
   hours (`events.intervals.['24h']`) is higher than 20.000.
 additionalProperties: false
-required:
-  - distinctIp
-  - distinctLinkedId
-  - distinctCountry
-  - events
-  - ipEvents
-  - distinctIpByLinkedId
-  - distinctVisitorIdByLinkedId
 properties:
   distinctIp:
     $ref: VelocityData.yaml

schemas/components/schemas/WebhookVirtualMachine.yaml

@@ -1,7 +1,5 @@
 type: object
 additionalProperties: false
-required:
-  - result
 properties:
   result:
     type: boolean

schemas/paths/examples/get_visitors_200_limit_1.json

@@ -10,8 +10,7 @@
         "os": "Mac OS X",
         "osVersion": "10.15.7",
         "device": "Other",
-        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.61 Safari/537.36",
-        "botProbability": 0
+        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.61 Safari/537.36"
       },
       "incognito": false,
       "ip": "82.118.30.68",