From 1f6a01eb280d95958d236c53371303d568d26663 Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Sun, 19 May 2024 21:45:09 +0200 Subject: [PATCH] api-docs: Update GET /users/me/subscriptions for channel. 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. --- zerver/openapi/zulip.yaml | 6 +++--- zerver/tests/test_docs.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 4e82970f40..51da0d17fd 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -9141,10 +9141,10 @@ paths: /users/me/subscriptions: get: operationId: get-subscriptions - summary: Get subscribed streams + summary: Get subscribed channels tags: ["streams"] 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 # corresponds to an endpoint. TODO: Add these for more # endpoints, and perhaps use this to provide links to implementations. @@ -9182,7 +9182,7 @@ paths: type: array description: | 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 in Zulip 8.0 (feature level 226). diff --git a/zerver/tests/test_docs.py b/zerver/tests/test_docs.py index cd5b211d75..08e6a342c3 100644 --- a/zerver/tests/test_docs.py +++ b/zerver/tests/test_docs.py @@ -174,7 +174,7 @@ class DocPageTest(ZulipTestCase): "/api/get-own-user": "does not accept any parameters.", "/api/get-stream-id": "The name of the channel to access.", "/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/installation-instructions": "No download required!", "/api/register-queue": "apply_markdown",