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

events: Document unintentionally exposed API fields. 

It's a bug that these are sent in event payloads; I'll open an issue
for resolving that issue.  For now we document them mainly to make our
tests pass.
This commit is contained in:
Tim Abbott 2020-07-27 18:05:44 -07:00
parent 227c90a4ae
commit dbde901684
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
zerver/openapi/zulip.yaml
View File

@ -494,28 +494,48 @@ paths:
type: string
email_notified:
type: boolean
deprecated: true
description: |
Whether the user receiving the event has already been
notified via email.
**Deprecated**: This field is present only due to a bug and
will be removed from the API.
push_notified:
type: boolean
deprecated: true
description: |
Whether the user receiving the event has already been
notified via mobile notification.
**Deprecated**: This field is present only due to a bug and
will be removed from the API.
stream_push_notify:
type: boolean
deprecated: true
description: |
Whether the user receiving the event has to be notified
via mobile notification for stream message.
**Deprecated**: This field is present only due to a bug and
will be removed from the API.
stream_email_notify:
type: boolean
deprecated: true
description: |
Whether the user receiving the event has to be notified
via email for stream message.
**Deprecated**: This field is present only due to a bug and
will be removed from the API.
wildcard_mention_notify:
type: boolean
deprecated: true
description: |
Whether the user has to be notified due to wildcard mention.
**Deprecated**: This field is present only due to a bug and
will be removed from the API.
additionalProperties: false
example:
{
@ -550,6 +570,13 @@ paths:
type: string
description: |
The ID of the registered queue.
handler_id:
type: integer
description: |
An internal field that should not be present in these API responses.
**Deprecated**: This will be removed in a future release.
deprecated: true
- example:
{
"queue_id": "1375801870:2942",