paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 22:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

api_docs: Document is_guest field in the get_members API.

Browse Source
This commit is contained in:
Puneeth Chaganti
2019-01-23 12:11:29 +05:30
committed by Tim Abbott
parent 10211e7565
commit 382d3085c4
2 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
templates/zerver/api/get-all-users.md
View File

@@ -71,6 +71,7 @@ curl {{ api_url }}/v1/users?client_gravatar=true \
* `bot_owner`: If the user is a bot (i.e. `is_bot` is `True`), `bot_owner` * `bot_owner`: If the user is a bot (i.e. `is_bot` is `True`), `bot_owner`
is the email address of the user who created the bot. is the email address of the user who created the bot.
* `is_active`: A boolean specifying whether the user is active or not. * `is_active`: A boolean specifying whether the user is active or not.
* `is_guest`: A boolean specifying whether the user is a guest user or not.
#### Example response #### Example response

3
zerver/openapi/zulip.yaml
View File

@@ -925,6 +925,7 @@ paths:
"is_active": true, "is_active": true,
"is_admin": false, "is_admin": false,
"is_bot": false, "is_bot": false,
"is_guest": false,
"user_id": 1 "user_id": 1
}, },
{ {
@@ -935,6 +936,7 @@ paths:
"is_active": true, "is_active": true,
"is_admin": false, "is_admin": false,
"is_bot": false, "is_bot": false,
"is_guest": false,
"user_id": 3 "user_id": 3
}, },
{ {
@@ -945,6 +947,7 @@ paths:
"is_active": true, "is_active": true,
"is_admin": false, "is_admin": false,
"is_bot": false, "is_bot": false,
"is_guest": true,
"user_id": 24 "user_id": 24
} }
], ],