wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

ms, not s. Also add required flags

Browse source
This commit is contained in:
David Baker 2016-10-05 18:22:03 +01:00
parent 4a020025bc
commit fd8c1a43c7
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
api/client-server/notifications.yaml
View file

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