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

Alphabetise avatar_url and displayname and remove redundant descriptions on displayname

Browse source
This commit is contained in:
Tom Foster 2025-02-14 12:03:49 +00:00
parent 992cf9dc35
commit 3311b084bf
1 changed files with 11 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -46,26 +46,25 @@ paths:
schema:
oneOf:
- type: string
enum: ["displayname", "avatar_url"]
enum: ["avatar_url", "displayname"]
- type: string
description: Must follow the [Common Namespaced Identifier Grammar](/appendices/#common-namespaced-identifier-grammar).
requestBody:
description: >
The new profile field value. The JSON object must contain the "key_name" specified in the URL.
For custom keys, the value may be any valid JSON type. However, if the key is "displayname"
or "avatar_url", the value MUST be a string as per the stabilised spec requirements.
or "avatar_url", the value MUST be a string.
required: true
content:
application/json:
schema:
type: object
properties:
displayname:
type: string
description: "Spec-conformant displayname value; must be a string."
avatar_url:
type: string
description: "Spec-conformant avatar URL value (MXC URI format); must be a string."
description: "Avatar URL value (MXC URI format)."
displayname:
type: string
additionalProperties:
description: "Any additional profile field value; may be any valid JSON type."
example: { "displayname": "Alice Wonderland" }
@ -146,7 +145,7 @@ paths:
schema:
oneOf:
- type: string
enum: ["displayname", "avatar_url"]
enum: ["avatar_url", "displayname"]
- type: string
description: Must follow the
[Common Namespaced Identifier Grammar](/appendices/#common-namespaced-identifier-grammar).
@ -158,12 +157,11 @@ paths:
schema:
type: object
properties:
displayname:
type: string
description: "Spec-conformant displayname value; must be a string."
avatar_url:
type: string
description: "Spec-conformant avatar URL value (MXC URI format); must be a string."
description: "Avatar URL value (MXC URI format)."
displayname:
type: string
additionalProperties:
description: "Any additional profile field value; may be any valid JSON type."
examples:
@ -217,7 +215,7 @@ paths:
schema:
oneOf:
- type: string
enum: ["displayname", "avatar_url"]
enum: ["avatar_url", "displayname"]
- type: string
description: Must follow the
[Common Namespaced Identifier Grammar](/appendices/#common-namespaced-identifier-grammar).
@ -297,10 +295,9 @@ paths:
avatar_url:
type: string
format: uri
description: "Spec-conformant avatar URL value (MXC URI format); must be a string."
description: "Avatar URL value (MXC URI format)."
displayname:
type: string
description: "Spec-conformant displayname value; must be a string."
additionalProperties:
description: "Any additional profile field value; may be any valid JSON type."
examples: