Skip to content

Commit

Permalink
Clarify what fields are required when deleting a pusher (matrix-org#1321
Browse files Browse the repository at this point in the history
)

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
  • Loading branch information
zecakeh authored and clokep committed May 3, 2023
1 parent 402ca51 commit fb8c9b8
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1321.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify what fields are required when deleting a pusher
31 changes: 19 additions & 12 deletions data/api/client-server/pusher.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,11 @@ paths:
This endpoint allows the creation, modification and deletion of [pushers](/client-server-api/#push-notifications)
for this user ID. The behaviour of this endpoint varies depending on the
values in the JSON body.
If `kind` is not `null`, the pusher with this `app_id` and `pushkey`
for this user is updated, or it is created if it doesn't exist. If
`kind` is `null`, the pusher with this `app_id` and `pushkey` for this
user is deleted.
operationId: postPusher
security:
- accessToken: []
Expand Down Expand Up @@ -177,7 +182,9 @@ paths:
If the `kind` is `"email"`, this is the email address to
send notifications to.
kind:
type: string
type:
- "string"
- "null"
description: |-
The kind of pusher to configure. `"http"` makes a pusher that
sends HTTP pokes. `"email"` makes a pusher that emails the
Expand All @@ -194,13 +201,13 @@ paths:
app_display_name:
type: string
description: |-
A string that will allow the user to identify what application
owns this pusher.
Required if `kind` is not `null`. 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.
Required if `kind` is not `null`. A string that will allow the
user to identify what device owns this pusher.
profile_tag:
type: string
description: |-
Expand All @@ -209,14 +216,15 @@ paths:
lang:
type: string
description: |-
The preferred language for receiving notifications (e.g. 'en'
or 'en-US').
Required if `kind` is not `null`. 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.
Required if `kind` is not `null`. 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:
Expand All @@ -243,8 +251,7 @@ paths:
different user IDs. Otherwise, the homeserver must remove any
other pushers with the same App ID and pushkey for different
users. The default is `false`.
required: ['kind', 'app_id', 'app_display_name',
'device_display_name', 'pushkey', 'lang', 'data']
required: ['kind', 'app_id', 'pushkey']
responses:
200:
description: The pusher was set.
Expand Down

0 comments on commit fb8c9b8

Please sign in to comment.