Notification Create v1¶
Source schema: doc/schemas/notification-create.v1.schema.json
Host capability request used by authorized producers to create a durable local notification. Raw body/input is transient request material and MUST NOT be persisted.
Governing Basis¶
Project Lineage¶
Fields¶
| Field | Required | Shape | Description |
|---|---|---|---|
schema |
yes |
const: notification-create.v1 |
|
idempotency/key |
yes |
string | |
notification/kind |
yes |
string | |
correlation/id |
no |
string | |
collapse/key |
no |
string | |
sender/ref |
no |
string | |
recipient/class |
yes |
ref: #/$defs/recipientClass |
|
recipient/id |
no |
string | |
subject/ref |
no |
string | |
priority |
yes |
ref: #/$defs/priority |
|
reason/code |
yes |
string | |
expires/at |
no |
string | |
title |
yes |
string | |
body/text |
no |
string | |
body/ref |
no |
string | |
body/input |
no |
unspecified | Transient producer input used only for validation, action rendering context, or digesting. It MUST NOT be persisted by the notification store. |
actions |
no |
array |
Definitions¶
| Definition | Shape | Description |
|---|---|---|
priority |
enum: low, medium, high |
|
recipientClass |
enum: operator, user, pod-user, role |
|
action |
object | |
| ## Field Semantics |
schema¶
- Required:
yes - Shape: const:
notification-create.v1
idempotency/key¶
- Required:
yes - Shape: string
notification/kind¶
- Required:
yes - Shape: string
correlation/id¶
- Required:
no - Shape: string
collapse/key¶
- Required:
no - Shape: string
sender/ref¶
- Required:
no - Shape: string
recipient/class¶
- Required:
yes - Shape: ref:
#/$defs/recipientClass
recipient/id¶
- Required:
no - Shape: string
subject/ref¶
- Required:
no - Shape: string
priority¶
- Required:
yes - Shape: ref:
#/$defs/priority
reason/code¶
- Required:
yes - Shape: string
expires/at¶
- Required:
no - Shape: string
title¶
- Required:
yes - Shape: string
body/text¶
- Required:
no - Shape: string
body/ref¶
- Required:
no - Shape: string
body/input¶
- Required:
no - Shape: unspecified
Transient producer input used only for validation, action rendering context, or digesting. It MUST NOT be persisted by the notification store.
actions¶
- Required:
no - Shape: array
Definition Semantics¶
$defs.priority¶
- Shape: enum:
low,medium,high
$defs.recipientClass¶
- Shape: enum:
operator,user,pod-user,role
$defs.action¶
- Shape: object