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

Tailor descriptions to GET method

Browse source
This commit is contained in:
David Baker 2016-04-12 09:56:24 +01:00
parent 4fafe1ab73
commit 4b294b23de
1 changed files with 6 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -61,23 +61,18 @@ paths:
pushkey: pushkey:
type: string type: string
description: |- description: |-
This is a unique identifier for this pusher. The value you This is a unique identifier for this pusher. See /set for
should use for this is the routing or destination address more detail.
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. Max length, 512 bytes.
kind: kind:
type: string type: string
description: |- description: |-
The kind of pusher to configure. ``"http"`` makes a pusher that The kind of pusher. ``"http"`` is a pusher that
sends HTTP pokes. ``null`` deletes the pusher. sends HTTP pokes.
app_id: app_id:
type: string type: string
description: |- description: |-
This is a reverse-DNS style identifier for the application. 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. Max length, 64 chars.
app_display_name: app_display_name:
type: string type: string
@ -87,7 +82,7 @@ paths:
device_display_name: device_display_name:
type: string type: string
description: |- description: |-
a string that will allow the user to identify what device owns A string that will allow the user to identify what device owns
this pusher. this pusher.
profile_tag: profile_tag:
type: string type: string
@ -174,7 +169,7 @@ paths:
device_display_name: device_display_name:
type: string type: string
description: |- description: |-
a string that will allow the user to identify what device owns A string that will allow the user to identify what device owns
this pusher. this pusher.
profile_tag: profile_tag:
type: string type: string