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

openapi_responses: Fix list_subscriptions.

This commit is contained in:
orientor 2020-05-27 20:50:05 +05:30 committed by Tim Abbott
parent a4cf77e5dc
commit 4096e0e6b9
2 changed files with 63 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
templates/zerver/api/get-subscribed-streams.md
View File

@ -64,7 +64,7 @@ You may pass the `include_subscribers` query parameter as follows:
* `pin_to_top`: A boolean specifying whether the given stream has been pinned * `pin_to_top`: A boolean specifying whether the given stream has been pinned
to the top. to the top.
* `email_address`: Email address of the given stream. * `email_address`: Email address of the given stream.
* `in_home_view`: Whether the given stream is muted or not. Muted streams do * `is_muted`: Whether the given stream is muted or not. Muted streams do
not count towards your total unread count and thus, do not show up in not count towards your total unread count and thus, do not show up in
`All messages` view (previously known as `Home` view). `All messages` view (previously known as `Home` view).
* `color`: Stream color. * `color`: Stream color.

62
zerver/openapi/zulip.yaml
View File

@ -1812,8 +1812,70 @@ paths:
- properties: - properties:
subscriptions: subscriptions:
type: array type: array
description: |
A list of dictionaries where each dictionary contains
information about one of the subscribed streams.
items: items:
type: object type: object
properties:
stream_id:
type: integer
description: |
The unique ID of a stream.
name:
type: string
description: |
The name of a stream.
description:
type: string
description: |
A short description of a stream.
invite-only:
type: boolean
description: |
Specifies whether a stream is private or not.
Only people who have been invited can access a private stream.
subscribers:
type: array
items:
type: string
description: |
A list of email addresses of users who are also subscribed
to a given stream. Included only if `include_subscribers` is `true`.
desktop_notifications:
type: boolean
description: |
A boolean specifying whether desktop notifications
are enabled for the given stream.
push_notifications:
type: boolean
description: |
A boolean specifying whether push notifications
are enabled for the given stream.
audible_notifications:
type: boolean
description: |
A boolean specifying whether audible notifications
are enabled for the given stream.
pin_to_top:
type: boolean
description: |
A boolean specifying whether the given stream has been pinned
to the top.
email_address:
type: string
description: |
Email address of the given stream.
is_muted:
type: boolean
description: |
Whether the given stream is muted or not. Muted streams do
not count towards your total unread count and thus, do not show up in
`All messages` view (previously known as `Home` view).
color:
type: string
description: |
Stream color
- example: - example:
{ {
"msg": "", "msg": "",