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

Return an object as the root element

Browse source 
Because otherwise it's impossible to change later
This commit is contained in:
David Baker 2016-04-11 17:56:38 +01:00
parent 42834340e7
commit 4fafe1ab73
1 changed files with 76 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

145
api/client-server/pusher.yaml
View file

@ -30,81 +30,88 @@ paths:
description: The pushers for this user description: The pushers for this user
examples: examples:
application/json: |- application/json: |-
[ {
{ "pushers": [
"pushkey": "Xp/MzCt8/9DcSNE9cuiaoT5Ac55job3TdLSSmtmYl4A=", {
"kind": "http", "pushkey": "Xp/MzCt8/9DcSNE9cuiaoT5Ac55job3TdLSSmtmYl4A=",
"app_id": "face.mcapp.appy.prod", "kind": "http",
"app_display_name": "Appy McAppface", "app_id": "face.mcapp.appy.prod",
"device_display_name": "Alice's Phone", "app_display_name": "Appy McAppface",
"profile_tag": "xyz", "device_display_name": "Alice's Phone",
"lang": "en-US", "profile_tag": "xyz",
"data": { "lang": "en-US",
"url": "https://example.com/_matrix/push/v1/notify" "data": {
"url": "https://example.com/_matrix/push/v1/notify"
}
} }
} ]
] }
schema: schema:
type: array type: object
title: Pushers properties:
items: pushers:
type: object type: array
title: Pusher title: Pushers
properties: description: |-
pushkey: An array containing the current pushers for the user
type: string items:
description: |-
This is a unique identifier for this pusher. The value you
should use for this is the routing or destination address
information for the notification, for example, the APNS token
for APNS or the Registration ID for GCM. If your notification
client has no such concept, use any unique identifier.
Max length, 512 bytes.
kind:
type: string
description: |-
The kind of pusher to configure. ``"http"`` makes a pusher that
sends HTTP pokes. ``null`` deletes the pusher.
app_id:
type: string
description: |-
This is a reverse-DNS style identifier for the application.
It is recommended that this end with the platform, such that
different platform versions get different app identifiers.
Max length, 64 chars.
app_display_name:
type: string
description: |-
A string that will allow the user to identify what application
owns this pusher.
device_display_name:
type: string
description: |-
a string that will allow the user to identify what device owns
this pusher.
profile_tag:
type: string
description: |-
This string determines which set of device specific rules this
pusher executes.
lang:
type: string
description: |-
The preferred language for receiving notifications (e.g. 'en'
or 'en-US')
data:
type: object type: object
description: |- title: Pusher
A dictionary of information for the pusher implementation
itself. If ``kind`` is ``http``, this should contain ``url``
which is the URL to use to send notifications to.
title: PusherData
properties: properties:
url: pushkey:
type: string type: string
description: |- description: |-
Required if ``kind`` is ``http``. The URL to use to send This is a unique identifier for this pusher. The value you
notifications to. should use for this is the routing or destination address
information for the notification, for example, the APNS token
for APNS or the Registration ID for GCM. If your notification
client has no such concept, use any unique identifier.
Max length, 512 bytes.
kind:
type: string
description: |-
The kind of pusher to configure. ``"http"`` makes a pusher that
sends HTTP pokes. ``null`` deletes the pusher.
app_id:
type: string
description: |-
This is a reverse-DNS style identifier for the application.
It is recommended that this end with the platform, such that
different platform versions get different app identifiers.
Max length, 64 chars.
app_display_name:
type: string
description: |-
A string that will allow the user to identify what application
owns this pusher.
device_display_name:
type: string
description: |-
a string that will allow the user to identify what device owns
this pusher.
profile_tag:
type: string
description: |-
This string determines which set of device specific rules this
pusher executes.
lang:
type: string
description: |-
The preferred language for receiving notifications (e.g. 'en'
or 'en-US')
data:
type: object
description: |-
A dictionary of information for the pusher implementation
itself. If ``kind`` is ``http``, this should contain ``url``
which is the URL to use to send notifications to.
title: PusherData
properties:
url:
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":