84 lines
3.0 KiB
YAML
84 lines
3.0 KiB
YAML
|
get:
|
||
|
|
tags:
|
||
|
|
- hs-office-relationships
|
||
|
|
description: 'Fetch a single person relationship by its uuid, if visible for the current subject.'
|
||
|
|
operationId: getRelationshipByUuid
|
||
|
|
parameters:
|
||
|
|
- $ref: './auth.yaml#/components/parameters/currentUser'
|
||
|
|
- $ref: './auth.yaml#/components/parameters/assumedRoles'
|
||
|
|
- name: relationshipUUID
|
||
|
|
in: path
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
format: uuid
|
||
|
|
description: UUID of the relationship to fetch.
|
||
|
|
responses:
|
||
|
|
"200":
|
||
|
|
description: OK
|
||
|
|
content:
|
||
|
|
'application/json':
|
||
|
|
schema:
|
||
|
|
$ref: './hs-office-relationship-schemas.yaml#/components/schemas/HsOfficeRelationship'
|
||
|
|
|
||
|
|
"401":
|
||
|
|
$ref: './error-responses.yaml#/components/responses/Unauthorized'
|
||
|
|
"403":
|
||
|
|
$ref: './error-responses.yaml#/components/responses/Forbidden'
|
||
|
|
|
||
|
|
patch:
|
||
|
|
tags:
|
||
|
|
- hs-office-relationships
|
||
|
|
description: 'Updates a single person relationship by its uuid, if permitted for the current subject.'
|
||
|
|
operationId: patchRelationship
|
||
|
|
parameters:
|
||
|
|
- $ref: './auth.yaml#/components/parameters/currentUser'
|
||
|
|
- $ref: './auth.yaml#/components/parameters/assumedRoles'
|
||
|
|
- name: relationshipUUID
|
||
|
|
in: path
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
format: uuid
|
||
|
|
requestBody:
|
||
|
|
content:
|
||
|
|
'application/json':
|
||
|
|
schema:
|
||
|
|
$ref: './hs-office-relationship-schemas.yaml#/components/schemas/HsOfficeRelationshipPatch'
|
||
|
|
responses:
|
||
|
|
"200":
|
||
|
|
description: OK
|
||
|
|
content:
|
||
|
|
'application/json':
|
||
|
|
schema:
|
||
|
|
$ref: './hs-office-relationship-schemas.yaml#/components/schemas/HsOfficeRelationship'
|
||
|
|
"401":
|
||
|
|
$ref: './error-responses.yaml#/components/responses/Unauthorized'
|
||
|
|
"403":
|
||
|
|
$ref: './error-responses.yaml#/components/responses/Forbidden'
|
||
|
|
|
||
|
|
delete:
|
||
|
|
tags:
|
||
|
|
- hs-office-relationships
|
||
|
|
description: 'Delete a single person relationship by its uuid, if permitted for the current subject.'
|
||
|
|
operationId: deleteRelationshipByUuid
|
||
|
|
parameters:
|
||
|
|
- $ref: './auth.yaml#/components/parameters/currentUser'
|
||
|
|
- $ref: './auth.yaml#/components/parameters/assumedRoles'
|
||
|
|
- name: relationshipUUID
|
||
|
|
in: path
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
format: uuid
|
||
|
|
description: UUID of the relationship 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'
|