Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api-docs: Revise text of /api/test-notify endpoint. 

Updates title and main description to follow the general style
of the API endpoint documentation.

Updates `token` description to clarify suggested mobile client
behavior.
This commit is contained in:
Lauryn Menard 2023-11-30 19:07:25 +01:00 committed by Tim Abbott
parent 5051ad6ca5
commit d8044a1b07
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
zerver/openapi/zulip.yaml
View File

@ -9523,17 +9523,17 @@ paths:
/mobile_push/test_notification: /mobile_push/test_notification:
post: post:
operationId: test-notify operationId: test-notify
summary: Sends a test notification to the user's mobile device(s) summary: Send a test notification to mobile device(s)
tags: ["mobile"] tags: ["mobile"]
description: | description: |
This endpoint allows a user to trigger a test push notification to their Trigger sending a test push notification to the user's
selected mobile device, or all their mobile devices. selected mobile device or all of their mobile devices.
**Changes**: Starting with Zulip 8.0 (feature level 234), test **Changes**: Starting with Zulip 8.0 (feature level 234), test
notifications sent via this endpoint use `test` rather than notifications sent via this endpoint use `test` rather than
`test-by-device-token` in the `event` field. (All mobile push `test-by-device-token` in the `event` field. Also, as of this
notifications also now include a `realm_name` field as well as feature level, all mobile push notifications now include a
of this feature level). `realm_name` field.
New in Zulip 8.0 (feature level 217). New in Zulip 8.0 (feature level 217).
parameters: parameters:
@ -9542,11 +9542,11 @@ paths:
description: | description: |
The push token for the device to which to send the test notification. The push token for the device to which to send the test notification.
If this parameter is not submitted, the test notification will be sent to all of the If this parameter is not submitted, the test notification will be sent
user's devices registered on the server. to all of the user's devices registered on the server.
Mobile device clients should pass this parameter in order to trigger a notification A mobile client should pass this parameter, to avoid triggering a test
that is only delivered to this client. notification for other clients.
schema: schema:
type: string type: string
example: "111222" example: "111222"