diff --git a/templates/zerver/api/get-subscribed-streams.md b/templates/zerver/api/get-subscribed-streams.md index a7e5691c18..a05b679ab7 100644 --- a/templates/zerver/api/get-subscribed-streams.md +++ b/templates/zerver/api/get-subscribed-streams.md @@ -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 to the top. * `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 `All messages` view (previously known as `Home` view). * `color`: Stream color. diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 864998e967..4bf7531c4b 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -1812,8 +1812,70 @@ paths: - properties: subscriptions: type: array + description: | + A list of dictionaries where each dictionary contains + information about one of the subscribed streams. items: 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: { "msg": "",