paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-09 16:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

api-docs: Update "presences" object description in register response.

Browse Source 
Updates the description for `slim_presence` parameter as it relates
to the `presences` object that's returned in the response.

Adds the modern format for the `presences` object in the response
as that is what will be returned when the parameter above is True.
This commit is contained in:
Lauryn Menard
2024-06-27 20:22:37 +02:00
committed by Tim Abbott
parent d66ee33859
commit ae4ba8761c
1 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
zerver/openapi/zulip.yaml
View File

@@ -12970,10 +12970,11 @@ paths:
example: true example: true
slim_presence: slim_presence:
description: | description: |
Setting this to `true` will make presence dictionaries be keyed by If `true`, the `presences` object returned in the response will be keyed
user ID instead of Zulip API email. by user ID and the entry for each user's presence data will be in the
modern format.
**Changes**: New in Zulip 3.0 (Unstable with no feature level yet). **Changes**: New in Zulip 3.0 (no feature level; API unstable).
type: boolean type: boolean
default: false default: false
example: true example: true
@@ -13439,15 +13440,23 @@ paths:
A dictionary where each entry describes the presence details of a A dictionary where each entry describes the presence details of a
user in the Zulip organization. user in the Zulip organization.
The format of the entry (modern or legacy) depends on the value of
[`slim_presence`](#parameter-slim_presence).
Users who have been offline for multiple weeks may not appear in this object. Users who have been offline for multiple weeks may not appear in this object.
additionalProperties: additionalProperties:
type: object type: object
description: | description: |
`{user_id}` or `{user_email}`: Object containing the details of a user's Will be one of these two formats (modern or legacy) for user
presence . Depending on the value of `slim_presence`, the object's key is presence data:
either the user's ID or the user's Zulip API email. oneOf:
additionalProperties: - $ref: "#/components/schemas/ModernPresenceFormat"
$ref: "#/components/schemas/LegacyPresenceFormat" - type: object
description: |
`{user_email}`: Presence data (legacy format) for the user with
the specified Zulip API email.
additionalProperties:
$ref: "#/components/schemas/LegacyPresenceFormat"
presence_last_update_id: presence_last_update_id:
type: integer type: integer
description: | description: |