Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-02-17 19:43:43 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Attempt to describe variable payload content

Browse source
This commit is contained in:
Tom Foster 2025-02-20 18:08:10 +00:00
parent d8cc250d20
commit 37b1362bc1
1 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
data/api/client-server/profile.yaml
View file

@ -53,16 +53,16 @@ paths:
requestBody:
description:
A JSON object that must contain the `keyName` specified in the URL.
For custom keys, the value may be any valid JSON type,
but if the key is `avatar_url` or `displayname`, the value MUST be a string.
For custom keys, the value may be any valid JSON type, but if the key is
`avatar_url` or `displayname`, the value MUST be a string.
required: true
content:
application/json:
schema:
type: object
properties:
"<keyName>":
description: The field value to set; may be any valid JSON type.
minProperties: 1
additionalProperties:
description: The field value to set; may be any valid JSON type. For `avatar_url` and `displayname`, the value MUST be a string.
example: { "displayname": "Alice Wonderland" }
responses:
"200":
@ -148,10 +148,9 @@ paths:
application/json:
schema:
type: object
properties:
"<keyName>":
description: The field value to set; may be any valid JSON type.
additionalProperties: false
minProperties: 1
additionalProperties:
description: The profile field value; may be any valid JSON type.
examples:
response:
value: { "displayname": "Alice" }