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-13620: Expand search 201 response schema #87

Merged
merged 2 commits into from
Feb 13, 2024
Merged
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
50 changes: 32 additions & 18 deletions search.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ paths:
content:
application/json:
schema:
$ref: "#/definitions/PersonCreatedResponse"
$ref: "#/definitions/SearchResult"
400:
$ref: "./identification.yml#/components/responses/SearchBadParamsException"

Expand Down Expand Up @@ -59,21 +59,6 @@ definitions:
items:
type: string
format: uuid
PersonCreatedResponse:
type: object
properties:
code:
type: integer
description: "Result code."
persons:
type: array
description: "Array of Person images."
items:
$ref: "#/definitions/SearchPerson"
metadata:
type: object
additionalProperties: true
description: "A free-form object containing person's extended attributes."
RecognizeImage:
allOf:
- $ref: "./identification.yml#/components/schemas/Image"
Expand All @@ -92,12 +77,41 @@ definitions:
properties:
code:
type: integer
description: "Search result code."
description: "Result code. It is returned only with response 200."
persons:
type: array
description: "Person data."
description: "Array of Person images. It is returned only with response 200."
items:
$ref: "#/definitions/SearchPerson"
id:
type: string
format: uuid
description: "Person ID. The list of persons is sorted by decreasing ID value."
nullable: true
createdAt:
type: string
description: "Person creation date."
nullable: true
updatedAt:
type: string
description: "Person update date."
nullable: true
groups:
type: array
description: "List of groups this person belongs to."
nullable: true
items:
type: string
format: uuid
name:
type: string
description: "Person name."
nullable: true
metadata:
type: object
additionalProperties: true
description: "A free-form object containing person's extended attributes. Available when a person is being created"
nullable: true

SearchPerson:
allOf:
Expand Down
Loading