From 8a8db03a133a4102f932ec9f40a211b42d49c6d3 Mon Sep 17 00:00:00 2001 From: Lukas Lihotzki Date: Thu, 12 Aug 2021 23:13:54 +0200 Subject: [PATCH] OpenAPI: include peekEvents Disambiguate from getEvents by a trailing space in path (like inviteUser). Signed-off-by: Lukas Lihotzki --- .../client_server/newsfragments/3336.clarification | 1 + data/api/client-server/peeking_events.yaml | 9 ++++++--- 2 files changed, 7 insertions(+), 3 deletions(-) create mode 100644 changelogs/client_server/newsfragments/3336.clarification diff --git a/changelogs/client_server/newsfragments/3336.clarification b/changelogs/client_server/newsfragments/3336.clarification new file mode 100644 index 00000000..bb06ffec --- /dev/null +++ b/changelogs/client_server/newsfragments/3336.clarification @@ -0,0 +1 @@ +Disambiguate getEvents and peekEvents, and include both in swagger. diff --git a/data/api/client-server/peeking_events.yaml b/data/api/client-server/peeking_events.yaml index 85eb8768..0bf303ef 100644 --- a/data/api/client-server/peeking_events.yaml +++ b/data/api/client-server/peeking_events.yaml @@ -27,9 +27,11 @@ produces: securityDefinitions: $ref: definitions/security.yaml paths: - "/events": + # With an extra " " to disambiguate from the getEvents endpoint + # The extra space makes it sort first for what I'm sure is a good reason. + "/events ": get: - summary: Listen on the event stream. + summary: Listen on the event stream of a particular room. description: |- This will listen for new events related to a particular room and return them to the caller. This will block until an event is received, or until @@ -103,4 +105,5 @@ paths: - "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" 400: description: "Bad pagination `from` parameter." - # No tags to exclude this from the swagger UI - use the normal version instead. + tags: + - Room participation