Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api docs: Update GET /users to properly discuss bot_owner_id. 

This both documents changes in Zulip 2.2 to change this to
bot_owner_id.
This commit is contained in:
Tim Abbott 2020-04-18 15:29:31 -07:00
parent ad4097342b
commit 06af152145
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -66,8 +66,10 @@ You may pass the `client_gravatar` query parameter as follows:
`2` for an `Incoming webhook` bot. `3` for an `Outgoing webhook` bot.
`4` for an `Embedded` bot.
* `user_id`: The ID of the user.
* `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.
* `bot_owner_id`: If the user is a bot (i.e. `is_bot` is `True`), `bot_owner`
is the user ID of the bot's owner (usually, whoever created the bot).
**Changes**: New in Zulip 2.2. In previous versions, there was a `bot_owner`
field containing the email address of the bot's owner.
* `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.
* `timezone`: The time zone of the user.

4
templates/zerver/api/get-user.md
View File

@ -46,8 +46,8 @@ You may pass the `client_gravatar` or `include_custom_profile_fields` query para
`2` for an `Incoming webhook` bot. `3` for an `Outgoing webhook` bot.
`4` for an `Embedded` bot.
* `user_id`: The ID of the user.
* `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.
* `bot_owner_id`: If the user is a bot (i.e. `is_bot` is `True`), `bot_owner_id`
is user ID of the user who owns the bot (usually the creator).
* `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.
* `timezone`: The time zone of the user.