api docs: Clarify event structure when moving channels.

The previous language would most naturally be read as suggesting that
moving topics between channels would have these fields.
This commit is contained in:
Tim Abbott 2024-07-30 13:41:35 -07:00
parent a753f797f7
commit e7cc9090fd
1 changed files with 6 additions and 4 deletions

View File

@ -2537,8 +2537,9 @@ paths:
subject: subject:
type: string type: string
description: | description: |
Only present if this event moved messages to a different Only present if this event moved messages to a different topic;
topic. this field will not be present when moving messages to the same
topic name in a different channel.
The post-edit topic for all of the messages with IDs in The post-edit topic for all of the messages with IDs in
`message_ids`. `message_ids`.
@ -2557,8 +2558,9 @@ paths:
description: | description: |
The expanded target url which the link points to. The expanded target url which the link points to.
description: | description: |
Only present if this event moved messages to a different Only present if this event moved messages to a different topic;
topic. this field will not be present when moving messages to the same
topic name in a different channel.
Data on any links to be included in the `topic` Data on any links to be included in the `topic`
line (these are generated by line (these are generated by