54 lines
1.9 KiB
YAML
54 lines
1.9 KiB
YAML
components:
|
|
schemas:
|
|
RecipientBaseRequest:
|
|
type: object
|
|
additionalProperties: false
|
|
properties:
|
|
id:
|
|
description: Optional recipient identifier. Required by the current update handler.
|
|
$ref: ../../../models/objectid.yaml#/components/schemas/ObjectId
|
|
name:
|
|
description: Optional human-readable recipient name.
|
|
type: string
|
|
description:
|
|
description: Optional free-form recipient description.
|
|
type: string
|
|
nullable: true
|
|
email:
|
|
description: Optional recipient email address.
|
|
type: string
|
|
format: email
|
|
avatarUrl:
|
|
description: Optional avatar URL.
|
|
type: string
|
|
nullable: true
|
|
status:
|
|
description: Optional recipient status. When omitted, current handler behavior falls back to the model zero value (`ready`).
|
|
type: string
|
|
enum:
|
|
- ready
|
|
- registered
|
|
- notRegistered
|
|
type:
|
|
description: Optional recipient type. When omitted, current handler behavior falls back to the model zero value (`internal`).
|
|
type: string
|
|
enum:
|
|
- internal
|
|
- external
|
|
|
|
RecipientCreateRequest:
|
|
description: |
|
|
Request payload used to create a recipient.
|
|
The current create handler does not require any JSON fields beyond a valid object payload; organization context comes from the `org_ref` path parameter.
|
|
allOf:
|
|
- $ref: '#/components/schemas/RecipientBaseRequest'
|
|
|
|
RecipientUpdateRequest:
|
|
description: |
|
|
Request payload used to update a recipient.
|
|
The current PUT handler targets the record by `id` and then replaces it with the submitted values; omitted fields may therefore be reset to zero values.
|
|
required:
|
|
- id
|
|
allOf:
|
|
- $ref: '#/components/schemas/RecipientBaseRequest'
|