From d5488fc4f03bb38c402e58ae69b3ca9eeeb138f4 Mon Sep 17 00:00:00 2001 From: Alexander Date: Fri, 22 Mar 2024 17:01:28 +0300 Subject: [PATCH 1/2] SP-13816: Rectructure docs --- persons.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/persons.yml b/persons.yml index 04b2009..05833f9 100644 --- a/persons.yml +++ b/persons.yml @@ -7,7 +7,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' post: tags: - - person + - Face Identification summary: Create person operationId: create_person requestBody: @@ -27,7 +27,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' get: tags: - - person + - Face Identification summary: Get person operationId: get_person responses: @@ -39,7 +39,7 @@ paths: $ref: '#/components/responses/PersonNotFound' put: tags: - - person + - Face Identification summary: Update person operationId: update_person requestBody: @@ -58,7 +58,7 @@ paths: $ref: '#/components/responses/PersonNotFound' delete: tags: - - person + - Face Identification summary: Delete person operationId: delete_person responses: @@ -74,7 +74,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' get: tags: - - person + - Face Identification summary: Get person images operationId: get_all_images_by_person_id parameters: @@ -93,7 +93,7 @@ paths: $ref: '#/components/responses/PersonNotFound' post: tags: - - person + - Face Identification summary: Add person image operationId: add_image_to_person requestBody: @@ -121,7 +121,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' get: tags: - - person + - Face Identification summary: Get person image by id operationId: get_image_of_person parameters: @@ -142,7 +142,7 @@ paths: format: binary delete: tags: - - person + - Face Identification summary: Delete image of person operationId: delete_image_of_person parameters: @@ -164,7 +164,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' get: tags: - - person + - Face Identification summary: Get person groups operationId: get_all_groups_by_person_id parameters: From 019280c1ac5dd0c5324f8926609153c49a209248 Mon Sep 17 00:00:00 2001 From: Alexander Date: Fri, 22 Mar 2024 18:07:07 +0300 Subject: [PATCH 2/2] SP-13816: Rectructure docs --- detect.yml | 2 +- diagnostics.yml | 2 +- groups.yml | 14 +++++++------- liveness.yml | 2 +- match_and_search.yml | 2 +- matching.yml | 2 +- search.yml | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/detect.yml b/detect.yml index 0646a5f..7c44f19 100644 --- a/detect.yml +++ b/detect.yml @@ -5,7 +5,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' post: tags: - - matching + - Face Detection summary: "detect faces" description: "Detect face, evaluate attributes, assess the portrait quality" operationId: detect diff --git a/diagnostics.yml b/diagnostics.yml index df7b5a7..1838ecf 100644 --- a/diagnostics.yml +++ b/diagnostics.yml @@ -6,7 +6,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' get: tags: - - diagnostics + - Diagnostic summary: Checking the license status operationId: readiness responses: diff --git a/groups.yml b/groups.yml index 1b349a1..02fcd50 100644 --- a/groups.yml +++ b/groups.yml @@ -7,7 +7,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' get: tags: - - group + - Face Identification summary: Get groups operationId: get_all_groups parameters: @@ -24,7 +24,7 @@ paths: $ref: "./common.yml#/components/responses/BadRequest" post: tags: - - group + - Face Identification summary: Create group operationId: create_group requestBody: @@ -45,7 +45,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' get: tags: - - group + - Face Identification summary: Get group operationId: get_group responses: @@ -57,7 +57,7 @@ paths: $ref: "#/components/responses/GroupNotFound" put: tags: - - group + - Face Identification summary: Update group operationId: update_group requestBody: @@ -76,7 +76,7 @@ paths: $ref: "#/components/responses/GroupNotFound" delete: tags: - - group + - Face Identification summary: Delete group operationId: delete_group responses: @@ -90,7 +90,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' get: tags: - - group + - Face Identification summary: Get group persons operationId: get_all_persons_by_group_id parameters: @@ -113,7 +113,7 @@ paths: $ref: "./common.yml#/components/schemas/OperationLog" put: tags: - - group + - Face Identification summary: Add/remove persons to group operationId: update_persons_in_group requestBody: diff --git a/liveness.yml b/liveness.yml index babc7fc..fef6696 100644 --- a/liveness.yml +++ b/liveness.yml @@ -6,7 +6,7 @@ paths: - $ref: './common.yml#/components/parameters/transactionId' get: tags: - - liveness 2.0 + - Liveness Assessment summary: Liveness assessment operationId: get_liveness_transaction_info responses: diff --git a/match_and_search.yml b/match_and_search.yml index f2e30d0..9a090de 100644 --- a/match_and_search.yml +++ b/match_and_search.yml @@ -5,7 +5,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' post: tags: - - matching + - Face Comparison summary: 'match and search (1:1 + 1:N)' description: "To compare several images from a document and look up a person in the database in one request, use POST `/api/match_and_search`. In this case, the calculation of the descriptor will be performed only once, as opposed to using two requests for the same operation. If only one person is identified, matching is not performed and only search is carried out." operationId: match_and_search diff --git a/matching.yml b/matching.yml index 4ba58eb..b67b398 100755 --- a/matching.yml +++ b/matching.yml @@ -5,7 +5,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' post: tags: - - matching + - Face Comparison summary: "compare faces (1:1)" description: "To perform a comparison of faces in the same image or in two different images, use POST `/api/match`. It's possible to compare faces in the same image or in two different images, this is defined by the `images.type` parameter.

The face detection result is displayed in the `detections` field. diff --git a/search.yml b/search.yml index 0593c48..8aa9377 100644 --- a/search.yml +++ b/search.yml @@ -7,7 +7,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' post: tags: - - search + - Face Identification summary: Find person by image in groups operationId: search requestBody: