hs.hsadmin.ng/src/main/resources/api-definition/hs-office/hs-office-persons-with-uuid.yaml
Michael Hoennig f0eb76ee61 upgrade io.openapiprocessor:openapi-processor-spring to 2024.2 (#42)
Co-authored-by: Michael Hoennig <michael@hoennig.de>
Reviewed-on: #42
Reviewed-by: Marc Sandlus <marc.sandlus@hostsharing.net>
2024-04-16 10:08:00 +02:00

84 lines
2.8 KiB
YAML

get:
tags:
- hs-office-persons
description: 'Fetch a single business person by its uuid, if visible for the current subject.'
operationId: getPersonByUuid
parameters:
- $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: personUUID
in: path
required: true
schema:
type: string
format: uuid
description: UUID of the person to fetch.
responses:
"200":
description: OK
content:
'application/json':
schema:
$ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson'
"401":
$ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403":
$ref: 'error-responses.yaml#/components/responses/Forbidden'
patch:
tags:
- hs-office-persons
description: 'Updates a single person by its uuid, if permitted for the current subject.'
operationId: patchPerson
parameters:
- $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: personUUID
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
'application/json':
schema:
$ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePersonPatch'
responses:
"200":
description: OK
content:
'application/json':
schema:
$ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson'
"401":
$ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403":
$ref: 'error-responses.yaml#/components/responses/Forbidden'
delete:
tags:
- hs-office-persons
description: 'Delete a single business person by its uuid, if permitted for the current subject.'
operationId: deletePersonByUuid
parameters:
- $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: personUUID
in: path
required: true
schema:
type: string
format: uuid
description: UUID of the person to delete.
responses:
"204":
description: No Content
"401":
$ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403":
$ref: 'error-responses.yaml#/components/responses/Forbidden'
"404":
$ref: 'error-responses.yaml#/components/responses/NotFound'