OpenAPI: include peekEvents

Disambiguate from getEvents by a trailing space in path (like inviteUser).

Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
pull/977/head
Lukas Lihotzki 3 years ago committed by Richard van der Hoff
parent 3fb4fcaad9
commit 8a8db03a13

@ -0,0 +1 @@
Disambiguate getEvents and peekEvents, and include both in swagger.

@ -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

Loading…
Cancel
Save