Add format query parameter to GET /state/{eventType}/{stateKey}

Fixes #1047
This commit is contained in:
Tulir Asokan 2025-07-11 14:42:42 +03:00
parent 625ed5c599
commit 1947f2a72b
2 changed files with 17 additions and 1 deletions

View file

@ -0,0 +1 @@
Add `format` query parameter to `GET /state/{eventType}/{stateKey}` to allow fetching metadata of a specific state event.

View file

@ -105,9 +105,24 @@ paths:
example: ""
schema:
type: string
- in: query
name: format
description: |-
The format to use for the returned data. `content` (the default) will
return only the content of the state event. `event` will return the entire
event in the usual format suitable for clients, including fields like event
ID, sender and timestamp.
example: event
schema:
type: string
enum:
- content
- event
responses:
"200":
description: The content of the state event.
description: |-
The content of the state event, or the entire client-formatted event
if `?format=event` was used.
content:
application/json:
schema: