api-docs: Update changelog and notes about video call provider None.

Updates the changelog note in feature level 1 about adding None as
a video call provider to include the endpoints where this realm
setting is used.

Updates the OpenAPI doc for the realm setting `video_chat_provider`
to include information about the enum values and meanings.

Part of work on #22102.
This commit is contained in:
Lauryn Menard 2022-07-11 15:56:20 +02:00 committed by Tim Abbott
parent ddd9cc3ec9
commit edeacb63ff
2 changed files with 24 additions and 4 deletions

View File

@ -1049,7 +1049,9 @@ No changes; feature level used for Zulip 3.0 release.
Previously, they were 2-item tuples and did not include the time when Previously, they were 2-item tuples and did not include the time when
the topic was muted. the topic was muted.
* `GitLab` authentication is now available. * `GitLab` authentication is now available.
* Added `None` as a video call provider option. * [`POST /register`](/api/register-queue), [`GET /events`](/api/get-events),
`PATCH /realm`: None added as an option for the realm setting
`video_chat_provider` to disable video call UI.
## Changes in Zulip 2.1 ## Changes in Zulip 2.1

View File

@ -4037,7 +4037,16 @@ paths:
video_chat_provider: video_chat_provider:
type: integer type: integer
description: | description: |
The configured video call provider for the organization. The configured [video call provider](/help/start-a-call) for the
organization.
- 0 = None
- 1 = Jitsi Meet
- 3 = Zoom
- 4 = BigBlueButton
**Changes**: None added as an option in Zulip 3.0 (feature level 1)
to disable video call UI.
waiting_period_threshold: waiting_period_threshold:
type: integer type: integer
description: | description: |
@ -11135,7 +11144,16 @@ paths:
description: | description: |
Present if `realm` is present in `fetch_event_types`. Present if `realm` is present in `fetch_event_types`.
The configured video call provider for the organization. The configured [video call provider](/help/start-a-call) for the
organization.
- 0 = None
- 1 = Jitsi Meet
- 3 = Zoom
- 4 = BigBlueButton
**Changes**: None added as an option in Zulip 3.0 (feature level 1)
to disable video call UI.
realm_giphy_rating: realm_giphy_rating:
type: integer type: integer
description: | description: |
@ -11368,7 +11386,7 @@ paths:
organization administrator. organization administrator.
Useful for administrative settings UI that allows changing the Useful for administrative settings UI that allows changing the
video call provider. realm setting `video_chat_provider`.
additionalProperties: additionalProperties:
description: | description: |
`{provider_name}`: Dictionary containing the details of the `{provider_name}`: Dictionary containing the details of the