mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-02-23 06:23:43 +01:00
Add format query parameter to GET /state/{eventType}/{stateKey}
Fixes #1047
This commit is contained in:
parent
625ed5c599
commit
1947f2a72b
1
changelogs/client_server/newsfragments/2175.feature
Normal file
1
changelogs/client_server/newsfragments/2175.feature
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Add `format` query parameter to `GET /state/{eventType}/{stateKey}` to allow fetching metadata of a specific state event.
|
||||||
|
|
@ -105,9 +105,24 @@ paths:
|
||||||
example: ""
|
example: ""
|
||||||
schema:
|
schema:
|
||||||
type: string
|
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:
|
responses:
|
||||||
"200":
|
"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:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue