Merge pull request #112 from regulaforensics/release-7-1

Release 7.1

Author: ikliashchou

healthcheck.yml

@@ -6,6 +6,7 @@ paths:
       - $ref: "./common.yml#/components/parameters/x-request"
     get:
       summary: "Server healthcheck"
+      description: "The `/api/healthz` endpoint performs a server health check, providing details such as the application name, license ID, serial number, validity, and product version. <br><br>Comprehensive information about service diagnostics is available on the [Monitoring page](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/monitoring/)."
       operationId: healthz
       tags:
         - healthcheck
@@ -21,6 +22,7 @@ paths:
       - $ref: "./common.yml#/components/parameters/x-request"
     get:
       summary: "License healthcheck"
+      description: "The `/api/readyz` endpoint checks the license's health to determine if the application is ready for operation. It validates the license and returns a response indicating whether the license is valid (`200`) or invalid (`400`)."
       operationId: readyz
       tags:
         - healthcheck

identification.yml

@@ -208,6 +208,10 @@ components:
         id:
           type: string
           description: "Response image ID. The list is sorted by decreasing ID value."
+        content:
+          type: string
+          format: base64
+          description: "Base64-encoded image. Returned only if `withImages` is set to true in the request."
         contentType:
           type: string
           description: "Original media type of the returned image."

search.yml

@@ -5,6 +5,12 @@ paths:
   /search:
     parameters:
       - $ref: './common.yml#/components/parameters/x-request'
+      - in: query
+        name: withImages
+        required: false
+        schema:
+          type: boolean
+        description: "When enabled, the response includes Base64-encoded images of matched persons. Each entry in the `persons` array contains an `images` field with image IDs and content. If omitted or set to false, images are excluded."
     post:
       tags:
         - search
@@ -84,9 +90,7 @@ definitions:
 
   FilterOp:
     type: string
-    description: "The filter condition, determines the type of comparison to be performed on the `name` values of the Person entity. <br><br>When set to `in`, 
-    the `name` values of the Person should match any of the values specified in the `value` list. <br><br>When set to `nin`, 
-    the `name` values of the Person should not match any of the values specified in the `value` list."
+    description: "The filter condition, determines the type of comparison to be performed on the `name` values of the Person entity. <br><br>When set to `in`, the `name` values of the Person should match any of the values specified in the `value` list. <br><br>When set to `nin`, the `name` values of the Person should not match any of the values specified in the `value` list."
     enum:
       - "in"
       - "nin"