65 lines
2.3 KiB
YAML
65 lines
2.3 KiB
YAML
get:
|
|
tags: [Recipients]
|
|
summary: Get recipient by reference
|
|
description: Returns a recipient by `recipients_ref`.
|
|
operationId: recipientsGet
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- $ref: ../parameters/recipients_ref.yaml#/components/parameters/RecipientsRef
|
|
responses:
|
|
'200':
|
|
description: Recipient data
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
|
|
- type: object
|
|
properties:
|
|
data:
|
|
$ref: ./response/recipient.yaml#/components/schemas/RecipientsAuthData
|
|
'400':
|
|
$ref: ../response/operation.yaml#/components/responses/BadRequest
|
|
'401':
|
|
$ref: ../response/operation.yaml#/components/responses/Unauthorized
|
|
'403':
|
|
$ref: ../response/operation.yaml#/components/responses/Forbidden
|
|
'404':
|
|
$ref: ../response/operation.yaml#/components/responses/NotFound
|
|
'500':
|
|
$ref: ../response/operation.yaml#/components/responses/InternalServerError
|
|
|
|
delete:
|
|
tags: [Recipients]
|
|
summary: Delete recipient
|
|
description: Deletes recipient by reference. Use `cascade=true` to remove dependent objects when supported.
|
|
operationId: recipientsDelete
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- $ref: ../parameters/recipients_ref.yaml#/components/parameters/RecipientsRef
|
|
- $ref: ../parameters/cascade.yaml#/components/parameters/Cascade
|
|
responses:
|
|
'200':
|
|
description: Recipient deleted
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
|
|
- type: object
|
|
properties:
|
|
data:
|
|
$ref: ./response/recipient.yaml#/components/schemas/RecipientsAuthData
|
|
'400':
|
|
$ref: ../response/operation.yaml#/components/responses/BadRequest
|
|
'401':
|
|
$ref: ../response/operation.yaml#/components/responses/Unauthorized
|
|
'403':
|
|
$ref: ../response/operation.yaml#/components/responses/Forbidden
|
|
'404':
|
|
$ref: ../response/operation.yaml#/components/responses/NotFound
|
|
'500':
|
|
$ref: ../response/operation.yaml#/components/responses/InternalServerError
|