diff --git a/api_docs/changelog.md b/api_docs/changelog.md index 450b77c27b..b3e330b94e 100644 --- a/api_docs/changelog.md +++ b/api_docs/changelog.md @@ -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. diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index ed534ff89c..6380cc9d0e 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -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"