From eec36161476967a0a0db10b28a7140bc84d28b95 Mon Sep 17 00:00:00 2001
From: irynaharoshka <93273494+irynaharoshka@users.noreply.github.com>
Date: Wed, 13 Mar 2024 14:32:36 +0300
Subject: [PATCH] Fixes according to review
https://github.com/regulaforensics/FaceSDK-web-openapi/pull/91/files
---
common.yml | 12 +-----------
detect.yml | 1 -
index.yml | 10 +++++-----
matching.yml | 4 ++--
4 files changed, 8 insertions(+), 19 deletions(-)
diff --git a/common.yml b/common.yml
index e23c86e..ace13f6 100755
--- a/common.yml
+++ b/common.yml
@@ -449,17 +449,7 @@ components:
FaceSDKResultCode:
type: integer
- description: "The result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).
-
- Some of the values:
-
- - `0`—everything is OK
-
- - `1`—image is empty, try again with another image
-
- - `2`—face is not detected
-
- - `6`—data cannot be decoded as an image"
+ description: "The result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/)."
enum:
- 0
- 1
diff --git a/detect.yml b/detect.yml
index 0646a5f..d69fa8b 100644
--- a/detect.yml
+++ b/detect.yml
@@ -6,7 +6,6 @@ paths:
post:
tags:
- matching
- summary: "detect faces"
description: "Detect face, evaluate attributes, assess the portrait quality"
operationId: detect
requestBody:
diff --git a/index.yml b/index.yml
index eff3079..9c01efe 100755
--- a/index.yml
+++ b/index.yml
@@ -6,14 +6,14 @@ info:
url: 'https://static-content.regulaforensics.com/Icons/Logos/Regula-logo.svg'
href: 'https://mobile.regulaforensics.com/'
description: |
- Regula Face SDK is a cross-platform biometric verification solution for a digital identity verification process. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.
+ Regula Face SDK is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.
The Face SDK includes the following features:
- * Face Detection
- * Face Match (1:1)
- * Face Search (1:N)
- * Liveness Assessment
+ * Face detection and image quality assessment
+ * Face match (1:1)
+ * Face search (1:N)
+ * Liveness detection
Here is the OpenAPI specification on GitHub.
diff --git a/matching.yml b/matching.yml
index 4ba58eb..0317615 100755
--- a/matching.yml
+++ b/matching.yml
@@ -82,7 +82,7 @@ components:
type: integer
returnOriginalRect:
type: boolean
- description: "Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop. Can be used only if the face in the original image is not tilted."
+ description: "Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop."
default: null
size:
type: array
@@ -92,7 +92,7 @@ components:
type: integer
type:
type: integer
- description: "The aspect ratio according to which face alignment is performed. See the [FaceImageQualityAlignType enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-align-type/). To get a thumbnail with dimensions 3x4, set `0`."
+ description: "The aspect ratio according to which face alignment is performed. See the [FaceImageQualityAlignType enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-align-type/). To get a thumbnail with aspect ratio 3:4, set `0`."
default: null
enum:
- 0