paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-24 08:33:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

api-docs: Update GET /users/me/subscriptions for channel.

Browse Source 
Updates the API doc for GET /users/me/subscriptions endpoint to
use channel in descriptions instead of stream.

Part of the stream to channel rename project.
This commit is contained in:
Lauryn Menard
2024-05-19 21:45:09 +02:00
committed by Tim Abbott
parent a090dc32a1
commit 1f6a01eb28
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
zerver/openapi/zulip.yaml
View File

@@ -9141,10 +9141,10 @@ paths:
/users/me/subscriptions: /users/me/subscriptions:
get: get:
operationId: get-subscriptions operationId: get-subscriptions
summary: Get subscribed streams summary: Get subscribed channels
tags: ["streams"] tags: ["streams"]
description: | description: |
Get all streams that the user is subscribed to. Get all channels that the user is subscribed to.
# operationId can be used to record which view function # operationId can be used to record which view function
# corresponds to an endpoint. TODO: Add these for more # corresponds to an endpoint. TODO: Add these for more
# endpoints, and perhaps use this to provide links to implementations. # endpoints, and perhaps use this to provide links to implementations.
@@ -9182,7 +9182,7 @@ paths:
type: array type: array
description: | description: |
A list of dictionaries where each dictionary contains A list of dictionaries where each dictionary contains
information about one of the subscribed streams. information about one of the subscribed channels.
**Changes**: Removed `email_address` field from the dictionary **Changes**: Removed `email_address` field from the dictionary
in Zulip 8.0 (feature level 226). in Zulip 8.0 (feature level 226).

2
zerver/tests/test_docs.py
View File

@@ -174,7 +174,7 @@ class DocPageTest(ZulipTestCase):
"/api/get-own-user": "does not accept any parameters.", "/api/get-own-user": "does not accept any parameters.",
"/api/get-stream-id": "The name of the channel to access.", "/api/get-stream-id": "The name of the channel to access.",
"/api/get-streams": "include_public", "/api/get-streams": "include_public",
"/api/get-subscriptions": "Get all streams that the user is subscribed to.", "/api/get-subscriptions": "Get all channels that the user is subscribed to.",
"/api/get-users": "client_gravatar", "/api/get-users": "client_gravatar",
"/api/installation-instructions": "No download required!", "/api/installation-instructions": "No download required!",
"/api/register-queue": "apply_markdown", "/api/register-queue": "apply_markdown",