diff --git a/data/api/client-server/profile.yaml b/data/api/client-server/profile.yaml index 6a80f454..e6b68a9a 100644 --- a/data/api/client-server/profile.yaml +++ b/data/api/client-server/profile.yaml @@ -61,12 +61,16 @@ paths: schema: type: object minProperties: 1 - description: The JSON object must include a property whose key - matches the `keyName` specified in the URL. For `avatar_url`, - the value must be an MXC URI string. For `displayname`, the value - must be a string. For custom keys, any JSON type is allowed - - servers may not validate these values, but clients should follow - the format defined for that key. + description: | + An object which contains exactly one property. The key + of that property MUST match the `keyName` specified in the URL. + + For `avatar_url`, the value MUST be an MXC URI string. + + For `displayname`, the value MUST be a string. + + For custom keys, any JSON type is allowed. Servers MAY not validate + these values, but clients SHOULD follow the format defined for that key. additionalProperties: true example: { "displayname": "Alice Wonderland" } responses: