paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-06 15:03:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

api_docs: Add "Principals" component.

Browse Source 
To facilitate re-use of the same parameters in other paths, this commit
store the content of the parameter "principals" in components.
This commit is contained in:
shubhamgupta2956
2020-04-22 01:57:56 +05:30
committed by Tim Abbott
parent c4ebe98bba
commit db3d95fd16
1 changed files with 15 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
zerver/openapi/zulip.yaml
View File

@@ -1830,18 +1830,7 @@ paths:
type: boolean type: boolean
default: false default: false
example: true example: true
- name: principals - $ref: '#/components/parameters/Principals'
in: query
description: |
A list of email addresses of the users that will be subscribed to the
streams specified in the `subscriptions` argument. If not provided, then
the requesting user/bot is subscribed.
schema:
type: array
items:
type: string
default: []
example: ['ZOE@zulip.com']
- name: authorization_errors_fatal - name: authorization_errors_fatal
in: query in: query
description: | description: |
@@ -2039,17 +2028,7 @@ paths:
type: string type: string
example: ['Verona', 'Denmark'] example: ['Verona', 'Denmark']
required: true required: true
- name: principals - $ref: '#/components/parameters/Principals'
in: query
description: |
A list of email addresses of the users that will be unsubscribed from
the streams specified in the `subscriptions` argument. If not provided,
then the requesting user/bot is unsubscribed.
schema:
type: array
items:
type: string
example: ['ZOE@zulip.com']
responses: responses:
'200': '200':
description: Success. description: Success.
@@ -3834,3 +3813,16 @@ components:
type: boolean type: boolean
default: false default: false
example: true example: true
Principals:
name: principals
in: query
description: |
A list of email addresses of the users that will be subscribed/unsubscribed
to the streams specified in the `subscriptions` argument. If not provided, then
the requesting user/bot is subscribed.
schema:
type: array
items:
type: string
default: []
example: ['ZOE@zulip.com']