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

api-docs: Remove sender_short_name from message event example. 

Removes the `sender_short_name` from the example for the message
event in `/get-events`.

Also, to make this complete, adds Changes notes for the feature
level 26 changes that were made to the message objects returned
in the message events for `/get-events` and in the messages
array for the `/get-messages` response.

The field was originally removed from message objects in
commit b375581f58.
This commit is contained in:
Lauryn Menard 2023-06-21 18:06:17 +02:00 committed by Tim Abbott
parent 89794ce47c
commit 2edcfb65bb
2 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
api_docs/changelog.md
View File

@ -1296,8 +1296,9 @@ releases.
**Feature level 26**
* [`GET /messages`](/api/get-messages): `sender_short_name` field is no
longer included in return values for this endpoint.
* [`GET /messages`](/api/get-messages), [`GET /events`](/api/get-events):
The `sender_short_name` field is no longer included in message objects
returned by these endpoints.
* [`GET /messages`](/api/get-messages) : Removed `short_name` field from
`display_recipient` array objects.

12
zerver/openapi/zulip.yaml
View File

@ -846,6 +846,10 @@ paths:
- type: object
description: |
Event type for messages.
**Changes**: In Zulip 3.1 (feature level 26), the
`sender_short_name` field was removed from message
objects.
properties:
id:
$ref: "#/components/schemas/EventIdSchema"
@ -888,7 +892,6 @@ paths:
"reactions": [],
"submessages": [],
"sender_full_name": "King Hamlet",
"sender_short_name": "hamlet",
"sender_email": "user10@zulip.testserver",
"sender_realm_str": "zulip",
"display_recipient": "Denmark",
@ -5791,8 +5794,11 @@ paths:
messages:
type: array
description: |
An array of `message` objects, each containing the following
fields:
An array of `message` objects.
**Changes**: In Zulip 3.1 (feature level 26), the
`sender_short_name` field was removed from message
objects.
items:
allOf:
- $ref: "#/components/schemas/MessagesBase"