Merge pull request #112 from fingerprintjs/SMSI-694/devtools

SMSI-694: Add developer tools smart signal
fingerprintjs · Jul 22, 2024 · ecb4e5f · ecb4e5f
2 parents 23fc00b + 0350ce7
commit ecb4e5f
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 1 deletion.
diff --git a/examples/get_event_200.json b/examples/get_event_200.json
@@ -303,6 +303,11 @@
           }
         }
       }
+    },
+    "developerTools": {
+      "data": {
+        "result": false
+      }
     }
   }
-}
+}
diff --git a/examples/get_event_200_all_errors.json b/examples/get_event_200_all_errors.json
@@ -147,6 +147,12 @@
         "code": "Failed",
         "message": "internal server error"
       }
+    },
+    "developerTools": {
+      "error": {
+        "code": "Failed",
+        "message": "internal server error"
+      }
     }
   }
 }
diff --git a/examples/webhook.json b/examples/webhook.json
@@ -215,5 +215,8 @@
         "24h": 5
       }
     }
+  },
+  "developerTools": {
+    "result": false
   }
 }
diff --git a/schemas/fingerprint-server-api.yaml b/schemas/fingerprint-server-api.yaml
@@ -921,6 +921,8 @@ components:
               $ref: '#/components/schemas/RemoteControlResult'
             velocity:
               $ref: '#/components/schemas/VelocityResult'
+            developerTools:
+              $ref: '#/components/schemas/DeveloperToolsResult'
           required:
             - visitorId
         - $ref: '#/components/schemas/Visit'
@@ -1426,6 +1428,15 @@ components:
               $ref: '#/components/schemas/VelocityResult'
             error:
               $ref: '#/components/schemas/ProductError'
+        developerTools:
+          title: SignalResponseDeveloperTools
+          type: object
+          additionalProperties: false
+          properties:
+            data:
+              $ref: '#/components/schemas/DeveloperToolsResult'
+            error:
+              $ref: '#/components/schemas/ProductError'
     EventResponse:
       description: Contains results from all activated products - Fingerprint Pro, Bot Detection, and others.
       type: object
@@ -1907,6 +1918,17 @@ components:
           example: false
       required:
         - result
+    DeveloperToolsResult:
+      type: object
+      additionalProperties: false
+      properties:
+        result:
+          type: boolean
+          description: >
+            `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise.
+          example: false
+      required:
+        - result
     EventUpdateRequest:
       type: object
       properties: