diff --git a/common.yml b/common.yml index 7bc460f..01a10f9 100755 --- a/common.yml +++ b/common.yml @@ -57,7 +57,7 @@ components: $ref: "#/components/schemas/OutputImageParams" quality: $ref: "#/components/schemas/QualityRequest" - attributes: + attributes: description: "Whether to evaluate attributes, such as age and emotions." type: boolean default: false @@ -85,6 +85,7 @@ components: Crop: type: object + description: "Whether to return the Base64 of an aligned and cropped portrait in the crop field." properties: type: $ref: "#/components/schemas/FaceImageQualityAlignType" @@ -108,13 +109,13 @@ components: QualityConfigList: type: array + description: "The configuration that defines the list of returned quality check characteristics." items: $ref: "#/components/schemas/QualityConfig" QualityConfig: type: object - description: "The configuration that defines the list of returned quality check characteristics. - For every characteristic, includes name, range, unit." + description: "The configuration that defines the list of returned quality check characteristics." properties: name: description: "The name of the characteristic." @@ -179,6 +180,7 @@ components: RGB: type: array + description: "The RGB value of a color for filling background behind a person's silhouette and for aligning the image." items: type: integer minItems: 3 @@ -199,7 +201,7 @@ components: FaceQualityScenarios: type: string - description: "Face detection scenarios." + description: "Face detection scenario." enum: - "OldMode" - "QualityFull" @@ -479,4 +481,4 @@ components: type: array items: type: number - example: [x, y, width, height] + example: [x, y, width, height] \ No newline at end of file diff --git a/detect.yml b/detect.yml index 65e23fa..76ffee7 100644 --- a/detect.yml +++ b/detect.yml @@ -7,8 +7,8 @@ paths: - $ref: './common.yml#/components/parameters/x-request' post: tags: - - matching - summary: "Detect facial coordinates" + - face detection + summary: "Find a face in the image, evaluate attributes, and assess the portrait quality" operationId: detect requestBody: required: true @@ -42,10 +42,6 @@ components: description: "Whether to return the cropped portrains with the detected faces." type: boolean default: false - attributes: - description: "Whether to evaluate attributes, such as age and emotions." - type: boolean - default: false DetectResponse: allOf: diff --git a/groups.yml b/groups.yml index 0bc9036..c204d39 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/index.yml b/index.yml index 215f597..02091b0 100755 --- a/index.yml +++ b/index.yml @@ -32,6 +32,8 @@ paths: $ref: './match_and_search.yml#/paths/~1match_and_search' /api/detect: $ref: './detect.yml#/paths/~1detect' + /api/search: + $ref: './search.yml#/paths/~1search' /api/persons: $ref: './persons.yml#/paths/~1persons' /api/persons/{person_id}: @@ -48,7 +50,5 @@ paths: $ref: './groups.yml#/paths/~1groups~1{group_id}' /api/groups/{group_id}/persons: $ref: './groups.yml#/paths/~1groups~1{group_id}~1persons' - /api/search: - $ref: './search.yml#/paths/~1search' /api/v2/liveness: $ref: './liveness.yml#/paths/~1v2~1liveness' diff --git a/liveness.yml b/liveness.yml index 64f78b5..3796127 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 operationId: get_liveness_transaction_info responses: diff --git a/match_and_search.yml b/match_and_search.yml index 90ae7bf..806a932 100644 --- a/match_and_search.yml +++ b/match_and_search.yml @@ -5,8 +5,8 @@ paths: - $ref: './common.yml#/components/parameters/x-request' post: tags: - - matching - summary: 'Match and Search in one request' + - face comparison + summary: 'Compare faces and look up a person in a database in one request' operationId: match_and_search requestBody: required: true diff --git a/matching.yml b/matching.yml index ef5cc47..f001c95 100755 --- a/matching.yml +++ b/matching.yml @@ -6,8 +6,8 @@ paths: - $ref: './common.yml#/components/parameters/x-request' post: tags: - - matching - summary: "Compare provided face images in all combinations and return the similarity score for each pair." + - face comparison + summary: "Compare faces in all combinations and return similarity score for each pair" operationId: match requestBody: required: true @@ -168,5 +168,5 @@ components: detectAll: type: boolean - description: "Whether to detect all faces in the image. If set to false, only one face is detected: the most central one." + description: "Whether to detect all faces in the image. If set to false, only the most central face is detected." default: true \ No newline at end of file diff --git a/persons.yml b/persons.yml index 5bf54bc..311f738 100644 --- a/persons.yml +++ b/persons.yml @@ -7,7 +7,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' get: tags: - - person + - face identification summary: Get persons operationId: get_all_persons parameters: @@ -25,7 +25,7 @@ paths: $ref: "./common.yml#/components/responses/BadRequest" post: tags: - - person + - face identification summary: Create person operationId: create_person requestBody: @@ -45,7 +45,7 @@ paths: - $ref: './common.yml#/components/parameters/x-request' get: tags: - - person + - face identification summary: Get person operationId: get_person responses: @@ -57,7 +57,7 @@ paths: $ref: '#/components/responses/PersonNotFound' put: tags: - - person + - face identification summary: Update person operationId: update_person requestBody: @@ -76,7 +76,7 @@ paths: $ref: '#/components/responses/PersonNotFound' delete: tags: - - person + - face identification summary: Delete person operationId: delete_person responses: @@ -92,7 +92,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: @@ -111,7 +111,7 @@ paths: $ref: '#/components/responses/PersonNotFound' post: tags: - - person + - face identification summary: Add person image operationId: add_image_to_person requestBody: @@ -138,7 +138,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: @@ -159,7 +159,7 @@ paths: format: binary delete: tags: - - person + - face identification summary: Delete image of person operationId: delete_image_of_person parameters: @@ -181,7 +181,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: diff --git a/search.yml b/search.yml index da8409a..a78c142 100644 --- a/search.yml +++ b/search.yml @@ -7,8 +7,8 @@ paths: - $ref: './common.yml#/components/parameters/x-request' post: tags: - - search - summary: Find person by image in groups. + - face identification + summary: Find person by image in groups operationId: search requestBody: required: true