SMSI-751: Add the confidence field to VPN response (#141)

* add the confidence field to VPN response * Update schemas/components/schemas/VpnResult.yaml add enum Co-authored-by: Juraj Uhlar <[email protected]> * Update schemas/components/schemas/VpnResult.yaml Co-authored-by: Juraj Uhlar <[email protected]> * add confidence to the required field * chore: add changeset * Update .changeset/orange-taxis-fetch.md Co-authored-by: Ilya Taratukhin <[email protected]> --------- Co-authored-by: Juraj Uhlar <[email protected]> Co-authored-by: Przemysław Żydek <[email protected]> Co-authored-by: Ilya Taratukhin <[email protected]>
fingerprintjs · Sep 25, 2024 · 262747c · 262747c
1 parent 6dd982a
commit 262747c
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/.changeset/orange-taxis-fetch.md b/.changeset/orange-taxis-fetch.md
@@ -0,0 +1,5 @@
+---
+'fingerprint-pro-server-api-openapi': minor
+---
+
+**visitors**: Add the confidence field to the VPN Detection Smart Signal
diff --git a/schemas/components/schemas/VpnResult.yaml b/schemas/components/schemas/VpnResult.yaml
@@ -46,7 +46,14 @@ properties:
       - publicVPN
       - auxiliaryMobile
       - osMismatch
+  confidence:
+    type: string
+    enum: [low, medium, high]
+    description: >-
+      A confidence rating for the VPN detection result — "low", "medium", or "high". Depends on the combination of results returned from all VPN detection methods.
+    example: low
 required:
   - result
   - originTimezone
   - methods
+  - confidence
diff --git a/schemas/paths/examples/get_event_200.json b/schemas/paths/examples/get_event_200.json
@@ -180,7 +180,8 @@
           "publicVPN": false,
           "auxiliaryMobile": false,
           "osMismatch": false
-        }
+        },
+        "confidence": "high"
       }
     },
     "proxy": {

diff --git a/schemas/paths/examples/webhook.json b/schemas/paths/examples/webhook.json
@@ -125,7 +125,8 @@
       "publicVPN": false,
       "auxiliaryMobile": false,
       "osMismatch": false
-    }
+    },
+    "confidence": "high"
   },
   "proxy": {
     "result": false