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

openapi: Add missing user property to deprecated user settings events. 

Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg 2023-10-22 19:23:09 -07:00 committed by Tim Abbott
parent f256a5a536
commit ce0040b69f
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
tools/check-schemas
View File

@ -67,9 +67,6 @@ from zerver.openapi.openapi import openapi_spec
# This list of exemptions represents details we should fix in Zulip's # This list of exemptions represents details we should fix in Zulip's
# API structure and/or validators. # API structure and/or validators.
EXEMPT_OPENAPI_NAMES = [ EXEMPT_OPENAPI_NAMES = [
# users field missing
"update_display_settings_event",
"update_global_notifications_event",
# Additional keys(push_users_notify) due to bug in API. # Additional keys(push_users_notify) due to bug in API.
"message_event", "message_event",
# tuple handling # tuple handling

10
zerver/openapi/zulip.yaml
View File

@ -257,6 +257,10 @@ paths:
- $ref: "#/components/schemas/EventTypeSchema" - $ref: "#/components/schemas/EventTypeSchema"
- enum: - enum:
- update_display_settings - update_display_settings
user:
type: string
description: |
The Zulip API email of the user.
setting_name: setting_name:
type: string type: string
description: | description: |
@ -278,6 +282,7 @@ paths:
example: example:
{ {
"type": "update_display_settings", "type": "update_display_settings",
"user": "iago@zulip.com",
"setting_name": "high_contrast_mode", "setting_name": "high_contrast_mode",
"setting": false, "setting": false,
"id": 0, "id": 0,
@ -302,6 +307,10 @@ paths:
- $ref: "#/components/schemas/EventTypeSchema" - $ref: "#/components/schemas/EventTypeSchema"
- enum: - enum:
- update_global_notifications - update_global_notifications
user:
type: string
description: |
The Zulip API email of the user.
notification_name: notification_name:
type: string type: string
description: | description: |
@ -317,6 +326,7 @@ paths:
example: example:
{ {
"type": "update_global_notifications", "type": "update_global_notifications",
"user": "iago@zulip.com",
"notification_name": "enable_sounds", "notification_name": "enable_sounds",
"setting": true, "setting": true,
"id": 0, "id": 0,