marked thumbnails deprecated + minor fixes (#70)

regulaforensics · Dec 12, 2023 · 94b8751 · 94b8751
1 parent 4cd978c
commit 94b8751
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/common.yml b/common.yml
@@ -73,7 +73,7 @@ components:
           description: "The RGB value for the background color: the silhouette of a person is cut out and the background is filled with this color."
           $ref: "#/components/schemas/RGB"
         crop:
-          description: "Whether to return the Base64 of an aligned and cropped portrait in the crop field."
+          description: "Whether to return the Base64 of an aligned and cropped portrait in the `crop` field."
           $ref: "#/components/schemas/Crop"
 
     QualityRequest:
@@ -88,11 +88,11 @@ components:
 
     Crop:
       type: object
-      description: "Whether to return the Base64 of an aligned and cropped portrait in the crop field."
+      description: "Whether to return the Base64 image of an aligned and cropped portrait in the `crop` field."
       properties:
         type:
           $ref: "#/components/schemas/FaceImageQualityAlignType"
-          description: "The dimensions ratio to the height of the required pattern."
+          description: "The aspect ratio according to which face alignment is performed during face detection."
           example: 1
         padColor:
           $ref: "#/components/schemas/RGB"
@@ -103,7 +103,7 @@ components:
             type: integer
           minItems: 2
           maxItems: 2
-          description: "The resize value in case type matches this value. If it doesn't, no resize is done."
+          description: "The resize value in case `type` matches this value. If it doesn't, no resize is performed."
           example: [300, 400]
         returnOriginalRect:
           type: boolean

diff --git a/detect.yml b/detect.yml
@@ -39,7 +39,7 @@ components:
         image:
           $ref: "./common.yml#/components/schemas/ImageData"
         thumbnails:
-          description: "Whether to return the cropped portrains with the detected faces."
+          description: "Deprecated, use the `crop` field in `processParam` instead."
           type: boolean
           default: false
 

diff --git a/matching.yml b/matching.yml
@@ -42,7 +42,7 @@ components:
           description: "Session identificator."
         thumbnails:
           type: boolean
-          description: "Whether to return thumbnails: Base64 cropped images that contain vertically aligned faces."
+          description: "Deprecated, use the `crop` field in `outputImageParams` instead."
           default: false
         images:
           type: array
@@ -61,7 +61,7 @@ components:
                 type: integer
             crop:
               type: object
-              description: "Whether to return the Base64 of an aligned and cropped portrait in the crop field."
+              description: "Whether to return the Base64 of an aligned and cropped portrait in the `crop` field."
               properties:
                 padColor:
                   type: array
@@ -75,7 +75,7 @@ components:
                   default: null
                 size:
                   type: array
-                  description: "The resize value in case type matches this value. If it doesn't, no resize is done."
+                  description: "The resize value in case `type` matches this value. If it doesn't, no resize is performed."
                   default: null
                   items:
                     type: integer