wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

OpenAPI: include peekEvents

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

Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
This commit is contained in:
Lukas Lihotzki 2021-08-12 23:13:54 +02:00 • committed by Richard van der Hoff
parent 3fb4fcaad9
commit 8a8db03a13
2 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/3336.clarification Normal file
View file

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

9
data/api/client-server/peeking_events.yaml
View file

@ -27,9 +27,11 @@ produces:
securityDefinitions: securityDefinitions:
$ref: definitions/security.yaml $ref: definitions/security.yaml
paths: 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: 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