Merge pull request #38 from regulaforensics/SP-6018-match_and_search_…

…request

[SP-6018] Add Match&Search in one request

.gitignore

@@ -1,2 +1,3 @@
 .idea
-*.html
+*.html
+/sample.json

identification.yml

@@ -63,12 +63,19 @@ components:
         created_at:
           type: string
           description: "The returned image creation date."
+        updated_at:
+          type: string
+          description: "The returned image update date."
         path:
           type: string
           description: "The returned image S3 path."
         url:
           type: string
           description: "The returned image URL."
+        metadata:
+          type: object
+          additionalProperties: true
+          description: "A free-form object containing person's extended attributes."
     GroupPage:
       allOf:
         - type: object

index.yml

@@ -20,6 +20,8 @@ servers:
 paths:
   /api/match:
     $ref: './matching.yml#/paths/~1match'
+  /api/match_and_search:
+    $ref: './match_and_search.yml#/paths/~1match_and_search'
   /api/detect:
     $ref: './detect.yml#/paths/~1detect'
   /api/persons:

match_and_search.yml

@@ -0,0 +1,88 @@
+openapi: 3.0.3
+paths:
+  /match_and_search:
+    parameters:
+      - $ref: './common.yml#/components/parameters/x-request'
+    post:
+      tags:
+        - matching
+      summary: 'Match and Search in one request'
+      operationId: match_and_search
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/MatchAndSearchRequest'
+      responses:
+        200:
+          description: 'Successful operation; the compare results are returned.'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MatchAndSearchResponse'
+        403:
+          $ref: './common.yml#/components/responses/BadLicense'
+components:
+  schemas:
+    MatchAndSearchRequest:
+      allOf:
+        - type: object
+          properties:
+            images:
+              type: array
+              items:
+                type: object
+                properties:
+                  content:
+                    $ref: './common.yml#/components/schemas/ImageData'
+                  type:
+                    $ref: './matching.yml#/components/schemas/ImageSource'
+        - $ref: './search.yml#/definitions/SearchParameters'
+
+    MatchAndSearchResponse:
+      allOf:
+        - $ref: './common.yml#/components/schemas/FaceSDKResult'
+        - type: object
+          properties:
+            detections:
+              type: array
+              items:
+                type: object
+                properties:
+                  faces:
+                    type: array
+                    items:
+                      allOf:
+                        - $ref: './matching.yml#/components/schemas/DetectionFace'
+                        - type: object
+                          properties:
+                            persons:
+                              type: array
+                              items:
+                                $ref: '#/components/schemas/PersonWithImages'
+                            rotationAngle:
+                              type: float
+                              example: 2.1272900104522705
+                  imageIndex:
+                    $ref: './matching.yml#/components/schemas/MatchImageIndex'
+                  status:
+                    $ref: './common.yml#/components/schemas/FaceSDKResultCode'
+            results:
+              $ref: './matching.yml#/components/schemas/MatchImageResult'
+            elapsedTime:
+              type: float
+              example: 1.317137987
+            metadata:
+              type: object
+              additionalProperties: true
+              description: "A free-form object containing person's extended attributes."
+    PersonWithImages:
+      allOf:
+        - type: object
+          properties:
+            images:
+              type: array
+              items:
+                $ref: './search.yml#/definitions/RecognizeImage'
+        - $ref: './identification.yml#/components/schemas/Person'

search.yml

@@ -29,23 +29,27 @@ paths:
 definitions:
   SearchRequest:
     allOf:
-      - type: object
-        description: "Request search data."
-        properties:
-          limit:
-            type: integer
-            default: 100
-            description: "The number of returned Persons limit."
-          threshold:
-            type: float
-            default: 1.0
-            description: "The similarity distance threshold."
-          group_ids:
-            type: array
-            description: "The IDs of the groups in which the search is performed."
-            items:
-              type: integer
+      - $ref: "#/definitions/SearchParameters"
       - $ref: "./identification.yml#/components/schemas/ImageFields"
+
+  SearchParameters:
+    type: object
+    description: "Request search data."
+    properties:
+      limit:
+        type: integer
+        default: 100
+        description: "The number of returned Persons limit."
+      threshold:
+        type: float
+        default: 1.0
+        description: "The similarity distance threshold."
+      group_ids:
+        type: array
+        description: "The IDs of the groups in which the search is performed."
+        items:
+          type: integer
+
   RecognizeImage:
     allOf:
       - $ref: "./identification.yml#/components/schemas/Image"