diff --git a/api/client-server/notifications.yaml b/api/client-server/notifications.yaml index 288987ab..f0ca4ec7 100644 --- a/api/client-server/notifications.yaml +++ b/api/client-server/notifications.yaml @@ -93,6 +93,7 @@ paths: type: object properties: next_token: + required: false type: string description: |- The token to supply in the ``from`` param of the next @@ -100,12 +101,14 @@ paths: events. notifications: type: array + required: true items: type: object title: notification properties: actions: type: array + required: true description: |- The action(s) to perform when the conditions for this rule are met. See `Push Rules: API`_. @@ -113,26 +116,31 @@ paths: type: string event: type: object + required: true title: Event description: The Event object for the event that triggered the notification. allOf: - "$ref": "definitions/event.yaml" profile_tag: type: string + required: false description: The profile tag of the rule that matched this event. read: type: boolean + required: true description: |- Indicates whether the user has sent a read receipt indicating that they have read this message. room_id: type: string + required: true description: The ID of the room in which the event was posted. ts: type: number + required: true description: |- The unix timestamp at which the event notification was sent, - in seconds. + in milliseconds. description: The list of events that triggered notifications. tags: - Notifications API