35db9aad43
Co-authored-by: Michael Hoennig <michael@hoennig.de> Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/122 Reviewed-by: Timotheus Pokorra <timotheus.pokorra@hostsharing.net>
84 lines
2.8 KiB
YAML
84 lines
2.8 KiB
YAML
get:
|
|
tags:
|
|
- hs-office-debitors
|
|
description: 'Fetch a single debitor by its uuid, if visible for the current subject.'
|
|
operationId: getSingleDebitorByUuid
|
|
parameters:
|
|
- $ref: 'auth.yaml#/components/parameters/currentSubject'
|
|
- $ref: 'auth.yaml#/components/parameters/assumedRoles'
|
|
- name: debitorUUID
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: UUID of the debitor to fetch.
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
'application/json':
|
|
schema:
|
|
$ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
|
|
|
|
"401":
|
|
$ref: 'error-responses.yaml#/components/responses/Unauthorized'
|
|
"403":
|
|
$ref: 'error-responses.yaml#/components/responses/Forbidden'
|
|
|
|
patch:
|
|
tags:
|
|
- hs-office-debitors
|
|
description: 'Updates a single debitor by its uuid, if permitted for the current subject.'
|
|
operationId: patchDebitor
|
|
parameters:
|
|
- $ref: 'auth.yaml#/components/parameters/currentSubject'
|
|
- $ref: 'auth.yaml#/components/parameters/assumedRoles'
|
|
- name: debitorUUID
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
requestBody:
|
|
content:
|
|
'application/json':
|
|
schema:
|
|
$ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitorPatch'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
content:
|
|
'application/json':
|
|
schema:
|
|
$ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
|
|
"401":
|
|
$ref: 'error-responses.yaml#/components/responses/Unauthorized'
|
|
"403":
|
|
$ref: 'error-responses.yaml#/components/responses/Forbidden'
|
|
|
|
delete:
|
|
tags:
|
|
- hs-office-debitors
|
|
description: 'Delete a single debitor by its uuid, if permitted for the current subject.'
|
|
operationId: deleteDebitorByUuid
|
|
parameters:
|
|
- $ref: 'auth.yaml#/components/parameters/currentSubject'
|
|
- $ref: 'auth.yaml#/components/parameters/assumedRoles'
|
|
- name: debitorUUID
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: UUID of the debitor 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'
|