openapi: Improve description of subscriptions in /users/me/subscripti…

…ons.
davidtwco · Oct 15, 2019 · 89d82ab · 89d82ab
1 parent 06883dc
commit 89d82ab
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml
@@ -1417,9 +1417,13 @@ paths:
       parameters:
       - name: subscriptions
         in: query
-        description: "A list of dictionaries, where each dictionary contains
-          key/value pairs specifying a particular stream to subscribe to.
-          You can specify an initial description here when creating a new stream.
+        description: "A list of dictionaries containing the the key `name`
+          and value specifying the name of the stream to subscribe. If the
+          stream does not exist a new stream is created. The description of the
+          stream created can be specified by setting the dictionary key
+          `description` with an appropriate value.
+
+
           **Note**: This argument is called `streams` and not `subscriptions`
           in our Python API."
         schema: