mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	api_docs: Document API changes to archived channels.
This commit is contained in:
		@@ -20,6 +20,19 @@ format used by the Zulip server that they are interacting with.
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
## Changes in Zulip 10.0
 | 
					## Changes in Zulip 10.0
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					**Feature level 362**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					* [`POST /users/me/subscriptions`](/api/subscribe),
 | 
				
			||||||
 | 
					  [`DELETE /users/me/subscriptions`](/api/unsubscribe): Subscriptions
 | 
				
			||||||
 | 
					  in archived channels can now be edited by users with the appropriate
 | 
				
			||||||
 | 
					  permission, just like in non-archived channels.
 | 
				
			||||||
 | 
					* [`PATCH /streams/{stream_id}`](/api/update-stream): Archived
 | 
				
			||||||
 | 
					  channels can now be converted between public and private channels,
 | 
				
			||||||
 | 
					  just like non-archived channels.
 | 
				
			||||||
 | 
					* [`POST /register`](/api/register-queue): The `never_subscribed` data
 | 
				
			||||||
 | 
					  structure now includes archived channels for clients that declared
 | 
				
			||||||
 | 
					  the `archived_channels` client capability.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
**Feature level 361**
 | 
					**Feature level 361**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
* [`POST /messages/{message_id}/typing`](/api/set-typing-status-for-message-edit):
 | 
					* [`POST /messages/{message_id}/typing`](/api/set-typing-status-for-message-edit):
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -34,7 +34,7 @@ DESKTOP_WARNING_VERSION = "5.9.3"
 | 
				
			|||||||
# new level means in api_docs/changelog.md, as well as "**Changes**"
 | 
					# new level means in api_docs/changelog.md, as well as "**Changes**"
 | 
				
			||||||
# entries in the endpoint's documentation in `zulip.yaml`.
 | 
					# entries in the endpoint's documentation in `zulip.yaml`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
API_FEATURE_LEVEL = 361
 | 
					API_FEATURE_LEVEL = 362
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Bump the minor PROVISION_VERSION to indicate that folks should provision
 | 
					# Bump the minor PROVISION_VERSION to indicate that folks should provision
 | 
				
			||||||
# only when going from an old version of the code to a newer version. Bump
 | 
					# only when going from an old version of the code to a newer version. Bump
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -10662,7 +10662,10 @@ paths:
 | 
				
			|||||||
        to a specified channel depends on the [channel's permissions
 | 
					        to a specified channel depends on the [channel's permissions
 | 
				
			||||||
        settings](/help/channel-permissions).
 | 
					        settings](/help/channel-permissions).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        **Changes**: Before Zulip 10.0 (feature level 357), the
 | 
					        **Changes**: Before Zulip 10.0 (feature level 362),
 | 
				
			||||||
 | 
					        subscriptions in archived channels could not be modified.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        Before Zulip 10.0 (feature level 357), the
 | 
				
			||||||
        `can_subscribe_group` permission, which allows members of the
 | 
					        `can_subscribe_group` permission, which allows members of the
 | 
				
			||||||
        group to subscribe themselves to the channel, did not exist.
 | 
					        group to subscribe themselves to the channel, did not exist.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -10931,6 +10934,9 @@ paths:
 | 
				
			|||||||
      tags: ["channels"]
 | 
					      tags: ["channels"]
 | 
				
			||||||
      description: |
 | 
					      description: |
 | 
				
			||||||
        Update which channels you are subscribed to.
 | 
					        Update which channels you are subscribed to.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        **Changes**: Before Zulip 10.0 (feature level 362),
 | 
				
			||||||
 | 
					        subscriptions in archived channels could not be modified.
 | 
				
			||||||
      requestBody:
 | 
					      requestBody:
 | 
				
			||||||
        required: false
 | 
					        required: false
 | 
				
			||||||
        content:
 | 
					        content:
 | 
				
			||||||
@@ -11065,13 +11071,16 @@ paths:
 | 
				
			|||||||
          by the [`can_remove_subscribers_group`][can-remove-parameter]
 | 
					          by the [`can_remove_subscribers_group`][can-remove-parameter]
 | 
				
			||||||
          for the channel.
 | 
					          for the channel.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        **Changes**: Before Zulip 8.0 (feature level 208), if a user
 | 
					        **Changes**: Before Zulip 10.0 (feature level 362),
 | 
				
			||||||
        specified by the [`principals`][principals-param] parameter was
 | 
					        subscriptions in archived channels could not be modified.
 | 
				
			||||||
        a deactivated user, or did not exist, then an HTTP status code
 | 
					
 | 
				
			||||||
        of 403 was returned with `code: "UNAUTHORIZED_PRINCIPAL"` in the
 | 
					        Before Zulip 8.0 (feature level 208), if a user specified by
 | 
				
			||||||
        error response. As of this feature level, an HTTP status code of
 | 
					        the [`principals`][principals-param] parameter was a
 | 
				
			||||||
        400 is returned with `code: "BAD_REQUEST"` in the error response
 | 
					        deactivated user, or did not exist, then an HTTP status code
 | 
				
			||||||
        for these cases.
 | 
					        of 403 was returned with `code: "UNAUTHORIZED_PRINCIPAL"` in
 | 
				
			||||||
 | 
					        the error response. As of this feature level, an HTTP status
 | 
				
			||||||
 | 
					        code of 400 is returned with `code: "BAD_REQUEST"` in the
 | 
				
			||||||
 | 
					        error response for these cases.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        Before Zulip 8.0 (feature level 197),
 | 
					        Before Zulip 8.0 (feature level 197),
 | 
				
			||||||
        the `can_remove_subscribers_group` setting
 | 
					        the `can_remove_subscribers_group` setting
 | 
				
			||||||
@@ -15431,7 +15440,11 @@ paths:
 | 
				
			|||||||
                          Important for clients containing UI where one can browse channels to subscribe
 | 
					                          Important for clients containing UI where one can browse channels to subscribe
 | 
				
			||||||
                          to.
 | 
					                          to.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
                          **Changes**: Prior to Zulip 10.0 (feature level 349), if a user was
 | 
					                          **Changes**: Before Zulip 10.0 (feature level 362), archived channels did
 | 
				
			||||||
 | 
					                          not appear in this list, even if the `archived_channels` [client
 | 
				
			||||||
 | 
					                          capability][client-capabilities] was declared by the client.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					                          Prior to Zulip 10.0 (feature level 349), if a user was
 | 
				
			||||||
                          in `can_administer_channel_group` of a channel that they never
 | 
					                          in `can_administer_channel_group` of a channel that they never
 | 
				
			||||||
                          subscribed to, but not an organization administrator, the channel
 | 
					                          subscribed to, but not an organization administrator, the channel
 | 
				
			||||||
                          in question would not be part of this array.
 | 
					                          in question would not be part of this array.
 | 
				
			||||||
@@ -20685,7 +20698,10 @@ paths:
 | 
				
			|||||||
        [private channel's permissions](/help/channel-permissions#private-channels)
 | 
					        [private channel's permissions](/help/channel-permissions#private-channels)
 | 
				
			||||||
        depends on them being subscribed to the channel.
 | 
					        depends on them being subscribed to the channel.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        **Changes**: Removed `stream_post_policy` and `is_announcement_only`
 | 
					        **Changes**: Before Zulip 10.0 (feature level 362), channel privacy could not be
 | 
				
			||||||
 | 
					        edited for archived channels.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        Removed `stream_post_policy` and `is_announcement_only`
 | 
				
			||||||
        parameters in Zulip 10.0 (feature level 333), as permission to post
 | 
					        parameters in Zulip 10.0 (feature level 333), as permission to post
 | 
				
			||||||
        in the channel is now controlled by `can_send_message_group`.
 | 
					        in the channel is now controlled by `can_send_message_group`.
 | 
				
			||||||
      x-curl-examples-parameters:
 | 
					      x-curl-examples-parameters:
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user