api-docs: Update the add and remove update_message_flags events.

Clarifies that the `all` field in the `op: "add"` event is only
relevant for the `"read"` message flag, and that it will be false
for all other specified flags in theses events.

Deprecates the `all` field in the `op: "remove"` event and document
that it is false for all specified flags.

Updates the deprecated `operation` field description and makes
a few other small revisions to the event text for clarity and
accuracy.
This commit is contained in:
Lauryn Menard
2023-09-19 13:22:20 +02:00
committed by Tim Abbott
parent 4fb5dee5a4
commit 48a1cf04d0
2 changed files with 24 additions and 34 deletions

View File

@@ -1630,7 +1630,7 @@ update_message_flags_remove_event = event_dict_type(
("type", Equals("update_message_flags")),
("op", Equals("remove")),
("operation", Equals("remove")),
("flag", EnumType(["read", "starred"])),
("flag", str),
("messages", ListType(int)),
("all", bool),
],