Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SP-13816: Rectructure docs #94

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion detect.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion diagnostics.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ paths:
- $ref: './common.yml#/components/parameters/x-request'
get:
tags:
- diagnostics
- Diagnostic
summary: Checking the license status
operationId: readiness
responses:
Expand Down
14 changes: 7 additions & 7 deletions groups.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -24,7 +24,7 @@ paths:
$ref: "./common.yml#/components/responses/BadRequest"
post:
tags:
- group
- Face Identification
summary: Create group
operationId: create_group
requestBody:
Expand All @@ -45,7 +45,7 @@ paths:
- $ref: './common.yml#/components/parameters/x-request'
get:
tags:
- group
- Face Identification
summary: Get group
operationId: get_group
responses:
Expand All @@ -57,7 +57,7 @@ paths:
$ref: "#/components/responses/GroupNotFound"
put:
tags:
- group
- Face Identification
summary: Update group
operationId: update_group
requestBody:
Expand All @@ -76,7 +76,7 @@ paths:
$ref: "#/components/responses/GroupNotFound"
delete:
tags:
- group
- Face Identification
summary: Delete group
operationId: delete_group
responses:
Expand All @@ -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:
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion liveness.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion match_and_search.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion matching.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br><br> The face detection result is displayed in the `detections` field.

Expand Down
18 changes: 9 additions & 9 deletions persons.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ paths:
- $ref: './common.yml#/components/parameters/x-request'
post:
tags:
- person
- Face Identification
summary: Create person
operationId: create_person
requestBody:
Expand All @@ -27,7 +27,7 @@ paths:
- $ref: './common.yml#/components/parameters/x-request'
get:
tags:
- person
- Face Identification
summary: Get person
operationId: get_person
responses:
Expand All @@ -39,7 +39,7 @@ paths:
$ref: '#/components/responses/PersonNotFound'
put:
tags:
- person
- Face Identification
summary: Update person
operationId: update_person
requestBody:
Expand All @@ -58,7 +58,7 @@ paths:
$ref: '#/components/responses/PersonNotFound'
delete:
tags:
- person
- Face Identification
summary: Delete person
operationId: delete_person
responses:
Expand All @@ -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:
Expand All @@ -93,7 +93,7 @@ paths:
$ref: '#/components/responses/PersonNotFound'
post:
tags:
- person
- Face Identification
summary: Add person image
operationId: add_image_to_person
requestBody:
Expand Down Expand Up @@ -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:
Expand All @@ -142,7 +142,7 @@ paths:
format: binary
delete:
tags:
- person
- Face Identification
summary: Delete image of person
operationId: delete_image_of_person
parameters:
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion search.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading