OpenAPI: include peekEvents

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

Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
pull/3336/head
Lukas Lihotzki 4 years ago
parent 10f1a12bfa
commit 2a7fb018b8

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

@ -27,9 +27,11 @@ produces:
securityDefinitions: securityDefinitions:
$ref: definitions/security.yaml $ref: definitions/security.yaml
paths: paths:
# 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 ": "/events ":
get: get:
summary: Listen on the event stream. summary: Listen on the event stream of a particular room.
description: |- description: |-
This will listen for new events related to a particular room and return 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 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" - "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml"
400: 400:
description: "Bad pagination `from` parameter." 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