EFRS-1333: Changed REST API docs due to change requests

Author: VolodymyrBushko

docs/Rest-API-description.md

@@ -886,22 +886,22 @@ Response body on success:
 | subject      | string | a subject in which the similar embedding was found                                         |
 | similarity   | float  | a similarity between the embedding and the input embedding                                 |
 
-### Face Verification Service, Embedding
-The service is used to determine similarities between an input source embedding and input target embeddings. An example:
+### Verify Faces from a Given Image, Embedding
+The endpoint is used to compare input embeddings to the embedding stored in Face Collection. An example:
 
 ```shell
-curl -X POST "http://localhost:8000/api/v1/verification/embeddings/verify" \
+curl -X POST "http://localhost:8000/api/v1/recognition/embeddings/faces/{image_id}/verify" \
 -H "Content-Type: application/json" \
 -H "x-api-key: <service_api_key>" \
--d {"source": [<source_embedding>], "targets": [["target_embedding"], ...]}
+-d {"embeddings": [[<array_of_embeddings>], ...]}
 ```
 
-| Element          | Description | Type    | Required | Notes                                                                                |
-|------------------|-------------|---------|----------|--------------------------------------------------------------------------------------|
-| Content-Type     | header      | string  | required | application/json                                                                     |
-| x-api-key        | header      | string  | required | api key of the Face verification service, created by the user                        |
-| source           | body        | array   | required | an input embeddings. The length depends on the model (e.g. 512 or 128)               |
-| targets          | body        | array   | required | an array of the target embeddings. The length depends on the model (e.g. 512 or 128) |
+| Element      | Description | Type   | Required | Notes                                                                  |
+|--------------|-------------|--------|----------|------------------------------------------------------------------------|
+| Content-Type | header      | string | required | application/json                                                       |
+| x-api-key    | header      | string | required | api key of the Face recognition service, created by the user           |
+| embeddings   | body        | array  | required | an input embeddings. The length depends on the model (e.g. 512 or 128) |
+| image_id     | variable    | UUID   | required | an id of the source embedding within the Face Collection               |
 
 Response body on success:
 ```json
@@ -916,28 +916,28 @@ Response body on success:
 }
 ```
 
-| Element     | Type   | Description                                                        |
-|-------------|--------|--------------------------------------------------------------------|
-| result      | array  | an array that contains all the results                             |
-| embedding   | array  | a target embedding which we are comparing to source embedding      |
-| similarity  | float  | a similarity between the source embedding and the target embedding |
+| Element     | Type   | Description                                                                  |
+|-------------|--------|------------------------------------------------------------------------------|
+| result      | array  | an array that contains all the results                                       |
+| embedding   | array  | a source embedding which we are comparing to embedding from Face Collection  |
+| similarity  | float  | a similarity between the source embedding and embedding from Face Collection |
 
-### Verify Faces from a Given Image, Embedding
-The endpoint is used to compare input embeddings to the embedding stored in Face Collection. An example:
+### Face Verification Service, Embedding
+The service is used to determine similarities between an input source embedding and input target embeddings. An example:
 
 ```shell
-curl -X POST "http://localhost:8000/api/v1/recognition/embeddings/faces/{image_id}/verify" \
+curl -X POST "http://localhost:8000/api/v1/verification/embeddings/verify" \
 -H "Content-Type: application/json" \
 -H "x-api-key: <service_api_key>" \
--d {"embeddings": [[<array_of_embeddings>], ...]}
+-d {"source": [<source_embedding>], "targets": [[<target_embedding>], ...]}
 ```
 
-| Element      | Description | Type   | Required | Notes                                                                  |
-|--------------|-------------|--------|----------|------------------------------------------------------------------------|
-| Content-Type | header      | string | required | application/json                                                       |
-| x-api-key    | header      | string | required | api key of the Face recognition service, created by the user           |
-| embeddings   | body        | array  | required | an input embeddings. The length depends on the model (e.g. 512 or 128) |
-| image_id     | variable    | UUID   | required | an id of the source embedding within the Face Collection               |
+| Element          | Description | Type    | Required | Notes                                                                                |
+|------------------|-------------|---------|----------|--------------------------------------------------------------------------------------|
+| Content-Type     | header      | string  | required | application/json                                                                     |
+| x-api-key        | header      | string  | required | api key of the Face verification service, created by the user                        |
+| source           | body        | array   | required | an input embeddings. The length depends on the model (e.g. 512 or 128)               |
+| targets          | body        | array   | required | an array of the target embeddings. The length depends on the model (e.g. 512 or 128) |
 
 Response body on success:
 ```json
@@ -952,8 +952,8 @@ Response body on success:
 }
 ```
 
-| Element     | Type   | Description                                                                  |
-|-------------|--------|------------------------------------------------------------------------------|
-| result      | array  | an array that contains all the results                                       |
-| embedding   | array  | a source embedding which we are comparing to embedding from Face Collection  |
-| similarity  | float  | a similarity between the source embedding and embedding from Face Collection |
+| Element     | Type   | Description                                                        |
+|-------------|--------|--------------------------------------------------------------------|
+| result      | array  | an array that contains all the results                             |
+| embedding   | array  | a target embedding which we are comparing to source embedding      |
+| similarity  | float  | a similarity between the source embedding and the target embedding |