From cf850b4270a63337314ffa9c84a4c9bad506e748 Mon Sep 17 00:00:00 2001 From: David Baker Date: Wed, 6 Apr 2016 20:21:08 +0100 Subject: [PATCH] Fix level of `counts` and `devices` They are actually within the notification object rather than the top level object. Add titles to objects so it works. --- api/push-gateway/push_notifier.yaml | 134 ++++++++++++++-------------- 1 file changed, 69 insertions(+), 65 deletions(-) diff --git a/api/push-gateway/push_notifier.yaml b/api/push-gateway/push_notifier.yaml index 48a438e2..e20dc8e9 100644 --- a/api/push-gateway/push_notifier.yaml +++ b/api/push-gateway/push_notifier.yaml @@ -55,29 +55,31 @@ paths: "content": { "msgtype": "m.text", "body": "I'm floating in a most peculiar way." - } - }, - "counts": { - "unread" : 2, - "missed_calls": 1 - }, - "devices": [ - { - "app_id": "org.matrix.matrixConsole.ios", - "pushkey": "V2h5IG9uIGVhcnRoIGRpZCB5b3UgZGVjb2RlIHRoaXM/", - "pushkey_ts": 12345678, - "data" : {}, - "tweaks": { - "sound": "bing" - } - } - ] + }, + "counts": { + "unread" : 2, + "missed_calls": 1 + }, + "devices": [ + { + "app_id": "org.matrix.matrixConsole.ios", + "pushkey": "V2h5IG9uIGVhcnRoIGRpZCB5b3UgZGVjb2RlIHRoaXM/", + "pushkey_ts": 12345678, + "data" : {}, + "tweaks": { + "sound": "bing" + } + } + ] + } } - required: ["notification", "counts", "devices"] + required: ["notification"] properties: notification: type: object + title: Notification description: Information about the push notification + required: ["devices"] properties: event_id: type: string @@ -136,56 +138,58 @@ paths: description: |- The ``content`` field from the event, if present. If the event had no content field, this field is omitted. - counts: - type: object - description: |- - This is a dictionary of the current number of unacknowledged - communications for the recipient user. Counts whose value is - zero are omitted. - properties: - unread: - type: integer + counts: + type: object + title: Counts description: |- - The number of unread messages a user has across all of the - rooms they are a member of. - missed_calls: - type: integer + This is a dictionary of the current number of unacknowledged + communications for the recipient user. Counts whose value is + zero are omitted. + properties: + unread: + type: integer + description: |- + The number of unread messages a user has across all of the + rooms they are a member of. + missed_calls: + type: integer + description: |- + The number of unacknowledged missed calls a user has + across all rooms of which they are a member. + devices: + type: array + title: Devices description: |- - The number of unacknowledged missed calls a user has - across all rooms of which they are a member. - devices: - type: array - title: Devices - description: |- - This is an array of devices that the notification should be sent to. - items: - type: object - properties: - app_id: - type: string - description: |- - The app_id given when the pusher was created. - pushkey: - type: string - description: The pushkey given when the pusher was created. - pushkey_ts: - type: integer - description: |- - The unix timestamp (in seconds) when the - pushkey was last updated. - data: - type: object - title: PusherData - description: |- - A dictionary of additional pusher-specific data. For - 'http' pushers, this is the data dictionary passed in at - pusher creation minus the ``url`` key. - tweaks: + This is an array of devices that the notification should be sent to. + items: type: object - title: Tweaks - description: |- - A dictionary of customisations made to the way this - notification is to be presented. These are added by push rules. + title: Device + properties: + app_id: + type: string + description: |- + The app_id given when the pusher was created. + pushkey: + type: string + description: The pushkey given when the pusher was created. + pushkey_ts: + type: integer + description: |- + The unix timestamp (in seconds) when the + pushkey was last updated. + data: + type: object + title: PusherData + description: |- + A dictionary of additional pusher-specific data. For + 'http' pushers, this is the data dictionary passed in at + pusher creation minus the ``url`` key. + tweaks: + type: object + title: Tweaks + description: |- + A dictionary of customisations made to the way this + notification is to be presented. These are added by push rules. responses: 200: description: A list of rejected push keys.