Single file specifications refresh (369921f)

onfido · Nov 14, 2024 · f603c73 · f603c73
1 parent 369921f
commit f603c73
Show file tree

Hide file tree

Showing 3 changed files with 145 additions and 0 deletions.
diff --git a/generated/artifacts/openapi-reference/openapi.json b/generated/artifacts/openapi-reference/openapi.json
@@ -4735,6 +4735,9 @@
           {
             "$ref": "#/components/schemas/report_shared"
           },
+          {
+            "$ref": "#/components/schemas/facial_similarity_report_shared"
+          },
           {
             "properties": {
               "breakdown": {
@@ -4753,6 +4756,9 @@
           {
             "$ref": "#/components/schemas/report_shared"
           },
+          {
+            "$ref": "#/components/schemas/facial_similarity_report_shared"
+          },
           {
             "properties": {
               "breakdown": {
@@ -4771,6 +4777,9 @@
           {
             "$ref": "#/components/schemas/report_shared"
           },
+          {
+            "$ref": "#/components/schemas/facial_similarity_report_shared"
+          },
           {
             "properties": {
               "breakdown": {
@@ -4789,6 +4798,9 @@
           {
             "$ref": "#/components/schemas/report_shared"
           },
+          {
+            "$ref": "#/components/schemas/facial_similarity_report_shared"
+          },
           {
             "properties": {
               "breakdown": {
@@ -5338,6 +5350,49 @@
         },
         "type": "object"
       },
+      "facial_similarity_report_shared": {
+        "properties": {
+          "live_photos": {
+            "description": "Array of objects with live photo ids that were used in the Onfido engine.",
+            "items": {
+              "$ref": "#/components/schemas/facial_similarity_report_media"
+            },
+            "type": "array"
+          },
+          "live_videos": {
+            "description": "Array of objects with live video ids that were used in the Onfido engine.",
+            "items": {
+              "$ref": "#/components/schemas/facial_similarity_report_media"
+            },
+            "type": "array"
+          },
+          "motion_captures": {
+            "description": "Array of objects with motion capture ids that were used in the Onfido engine.",
+            "items": {
+              "$ref": "#/components/schemas/facial_similarity_report_media"
+            },
+            "type": "array"
+          },
+          "id_photos": {
+            "description": "Array of objects with id photo ids that were used in the Onfido engine.",
+            "items": {
+              "$ref": "#/components/schemas/facial_similarity_report_media"
+            },
+            "type": "array"
+          }
+        }
+      },
+      "facial_similarity_report_media": {
+        "properties": {
+          "id": {
+            "description": "ID of uploaded biometric media to use.",
+            "format": "uuid",
+            "type": "string"
+          }
+        },
+        "required": ["id"],
+        "type": "object"
+      },
       "facial_similarity_photo_breakdown": {
         "properties": {
           "face_comparison": {

diff --git a/generated/artifacts/openapi-yaml/openapi/openapi.yaml b/generated/artifacts/openapi-yaml/openapi/openapi.yaml
@@ -3847,6 +3847,7 @@ components:
     facial_similarity_photo_report:
       allOf:
       - $ref: '#/components/schemas/report_shared'
+      - $ref: '#/components/schemas/facial_similarity_report_shared'
       - properties:
           breakdown:
             $ref: '#/components/schemas/facial_similarity_photo_breakdown'
@@ -3856,6 +3857,7 @@ components:
     facial_similarity_photo_fully_auto_report:
       allOf:
       - $ref: '#/components/schemas/report_shared'
+      - $ref: '#/components/schemas/facial_similarity_report_shared'
       - properties:
           breakdown:
             $ref: '#/components/schemas/facial_similarity_photo_fully_auto_breakdown'
@@ -3865,6 +3867,7 @@ components:
     facial_similarity_video_report:
       allOf:
       - $ref: '#/components/schemas/report_shared'
+      - $ref: '#/components/schemas/facial_similarity_report_shared'
       - properties:
           breakdown:
             $ref: '#/components/schemas/facial_similarity_video_breakdown'
@@ -3874,6 +3877,7 @@ components:
     facial_similarity_motion_report:
       allOf:
       - $ref: '#/components/schemas/report_shared'
+      - $ref: '#/components/schemas/facial_similarity_report_shared'
       - properties:
           breakdown:
             $ref: '#/components/schemas/facial_similarity_motion_breakdown'
@@ -4530,6 +4534,41 @@ components:
         extracted_data:
           $ref: '#/components/schemas/document_properties_extracted_data'
       type: object
+    facial_similarity_report_shared:
+      properties:
+        live_photos:
+          description: Array of objects with live photo ids that were used in the
+            Onfido engine.
+          items:
+            $ref: '#/components/schemas/facial_similarity_report_media'
+          type: array
+        live_videos:
+          description: Array of objects with live video ids that were used in the
+            Onfido engine.
+          items:
+            $ref: '#/components/schemas/facial_similarity_report_media'
+          type: array
+        motion_captures:
+          description: Array of objects with motion capture ids that were used in
+            the Onfido engine.
+          items:
+            $ref: '#/components/schemas/facial_similarity_report_media'
+          type: array
+        id_photos:
+          description: Array of objects with id photo ids that were used in the Onfido
+            engine.
+          items:
+            $ref: '#/components/schemas/facial_similarity_report_media'
+          type: array
+    facial_similarity_report_media:
+      properties:
+        id:
+          description: ID of uploaded biometric media to use.
+          format: uuid
+          type: string
+      required:
+      - id
+      type: object
     facial_similarity_photo_breakdown:
       properties:
         face_comparison:

diff --git a/generated/artifacts/openapi/openapi.json b/generated/artifacts/openapi/openapi.json
@@ -4087,6 +4087,8 @@
       "facial_similarity_photo_report" : {
         "allOf" : [ {
           "$ref" : "#/components/schemas/report_shared"
+        }, {
+          "$ref" : "#/components/schemas/facial_similarity_report_shared"
         }, {
           "properties" : {
             "breakdown" : {
@@ -4102,6 +4104,8 @@
       "facial_similarity_photo_fully_auto_report" : {
         "allOf" : [ {
           "$ref" : "#/components/schemas/report_shared"
+        }, {
+          "$ref" : "#/components/schemas/facial_similarity_report_shared"
         }, {
           "properties" : {
             "breakdown" : {
@@ -4117,6 +4121,8 @@
       "facial_similarity_video_report" : {
         "allOf" : [ {
           "$ref" : "#/components/schemas/report_shared"
+        }, {
+          "$ref" : "#/components/schemas/facial_similarity_report_shared"
         }, {
           "properties" : {
             "breakdown" : {
@@ -4132,6 +4138,8 @@
       "facial_similarity_motion_report" : {
         "allOf" : [ {
           "$ref" : "#/components/schemas/report_shared"
+        }, {
+          "$ref" : "#/components/schemas/facial_similarity_report_shared"
         }, {
           "properties" : {
             "breakdown" : {
@@ -4587,6 +4595,49 @@
         },
         "type" : "object"
       },
+      "facial_similarity_report_shared" : {
+        "properties" : {
+          "live_photos" : {
+            "description" : "Array of objects with live photo ids that were used in the Onfido engine.",
+            "items" : {
+              "$ref" : "#/components/schemas/facial_similarity_report_media"
+            },
+            "type" : "array"
+          },
+          "live_videos" : {
+            "description" : "Array of objects with live video ids that were used in the Onfido engine.",
+            "items" : {
+              "$ref" : "#/components/schemas/facial_similarity_report_media"
+            },
+            "type" : "array"
+          },
+          "motion_captures" : {
+            "description" : "Array of objects with motion capture ids that were used in the Onfido engine.",
+            "items" : {
+              "$ref" : "#/components/schemas/facial_similarity_report_media"
+            },
+            "type" : "array"
+          },
+          "id_photos" : {
+            "description" : "Array of objects with id photo ids that were used in the Onfido engine.",
+            "items" : {
+              "$ref" : "#/components/schemas/facial_similarity_report_media"
+            },
+            "type" : "array"
+          }
+        }
+      },
+      "facial_similarity_report_media" : {
+        "properties" : {
+          "id" : {
+            "description" : "ID of uploaded biometric media to use.",
+            "format" : "uuid",
+            "type" : "string"
+          }
+        },
+        "required" : [ "id" ],
+        "type" : "object"
+      },
       "facial_similarity_photo_breakdown" : {
         "properties" : {
           "face_comparison" : {