archive
/
matrix-spec
mirror of https://github.com/matrix-org/matrix-spec
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix format (array of objects, not object)

Browse Source
pull/977/head
David Baker 9 years ago
parent 27113d71ff
commit 0f6e414eb6
1 changed files with 59 additions and 56 deletions
Show Stats Download Patch File Download Diff File

115
api/client-server/pusher.yaml
Unescape Escape View File

@ -45,62 +45,65 @@ paths:
} }
] ]
schema: schema:
type: object type: array
properties: items:
pushkey: type: object
type: string title: Pusher
description: |- properties:
This is a unique identifier for this pusher. The value you pushkey:
should use for this is the routing or destination address type: string
information for the notification, for example, the APNS token description: |-
for APNS or the Registration ID for GCM. If your notification This is a unique identifier for this pusher. The value you
client has no such concept, use any unique identifier. should use for this is the routing or destination address
Max length, 512 bytes. information for the notification, for example, the APNS token
kind: for APNS or the Registration ID for GCM. If your notification
type: string client has no such concept, use any unique identifier.
description: |- Max length, 512 bytes.
The kind of pusher to configure. ``"http"`` makes a pusher that kind:
sends HTTP pokes. ``null`` deletes the pusher. type: string
app_id: description: |-
type: string The kind of pusher to configure. ``"http"`` makes a pusher that
description: |- sends HTTP pokes. ``null`` deletes the pusher.
This is a reverse-DNS style identifier for the application. app_id:
It is recommended that this end with the platform, such that type: string
different platform versions get different app identifiers. description: |-
Max length, 64 chars. This is a reverse-DNS style identifier for the application.
app_display_name: It is recommended that this end with the platform, such that
type: string different platform versions get different app identifiers.
description: |- Max length, 64 chars.
A string that will allow the user to identify what application app_display_name:
owns this pusher. type: string
device_display_name: description: |-
type: string A string that will allow the user to identify what application
description: |- owns this pusher.
a string that will allow the user to identify what device owns device_display_name:
this pusher. type: string
profile_tag: description: |-
type: string a string that will allow the user to identify what device owns
description: |- this pusher.
This string determines which set of device specific rules this profile_tag:
pusher executes. type: string
lang: description: |-
type: string This string determines which set of device specific rules this
description: |- pusher executes.
The preferred language for receiving notifications (e.g. 'en' lang:
or 'en-US') type: string
data: description: |-
type: object The preferred language for receiving notifications (e.g. 'en'
description: |- or 'en-US')
A dictionary of information for the pusher implementation data:
itself. If ``kind`` is ``http``, this should contain ``url`` type: object
which is the URL to use to send notifications to. description: |-
title: PusherData A dictionary of information for the pusher implementation
properties: itself. If ``kind`` is ``http``, this should contain ``url``
url: which is the URL to use to send notifications to.
type: string title: PusherData
description: |- properties:
Required if ``kind`` is ``http``. The URL to use to send url:
notifications to. type: string
description: |-
Required if ``kind`` is ``http``. The URL to use to send
notifications to.
tags: tags:
- Push notifications - Push notifications
"/pushers/set": "/pushers/set":

Write Preview
Loading…
Cancel
Save