Inline information from MSC4133, remove links

This commit is contained in:
Tom Foster 2025-02-14 12:39:19 +00:00
parent f3c269d951
commit 9327793007

View file

@ -23,9 +23,10 @@ paths:
This API sets or updates a specified profile field in a user's profile. You must have the This API sets or updates a specified profile field in a user's profile. You must have the
appropriate permissions (i.e. an access token) to modify the profile field. appropriate permissions (i.e. an access token) to modify the profile field.
**Note:** Setting a `null` value SHOULD NOT delete the field. However, servers MAY reject Setting a `null` value SHOULD NOT delete the field. Instead, it retains the key with a `null`
requests to store `null` values if they do not allow keys to exist with a `null` value. value, unless the server rejects the request due to lack of support for `null` values.
For more details, see [MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133). To fully remove a profile field, use the `DELETE` endpoint. Servers may impose an upper limit
on value length, and profile data is subject to a total size limit of 64 KiB.
operationId: setProfileField operationId: setProfileField
security: security:
- accessTokenQuery: [] - accessTokenQuery: []
@ -48,7 +49,8 @@ paths:
- type: string - type: string
enum: ["avatar_url", "displayname"] enum: ["avatar_url", "displayname"]
- type: string - type: string
description: Must follow the [Common Namespaced Identifier Grammar](/appendices/#common-namespaced-identifier-grammar). description: Must follow the
[Common Namespaced Identifier Grammar](/appendices/#common-namespaced-identifier-grammar).
requestBody: requestBody:
description: > description: >
The new profile field value. The JSON object must contain the "key_name" specified in the URL. The new profile field value. The JSON object must contain the "key_name" specified in the URL.
@ -125,9 +127,8 @@ paths:
get: get:
summary: Get the user's profile field. summary: Get the user's profile field.
description: |- description: |-
Get the value of a user's profile field. This API can retrieve the profile fields of the user Get the value of a user's profile field. This API retrieves stabilised fields and custom
or other users, either locally or on remote homeservers. For more details, see profile fields. Profile data is subject to a total size limit of 64 KiB.
[MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133).
operationId: getProfileField operationId: getProfileField
parameters: parameters:
- in: path - in: path
@ -190,11 +191,8 @@ paths:
delete: delete:
summary: Delete a profile field. summary: Delete a profile field.
description: |- description: |-
Delete the specified profile field from a user's profile. Delete the specified profile field from a user's profile. Note that setting a `null` value with the `PUT`
endpoint retains the key with a null value; use this `DELETE` endpoint to fully remove a profile field.
**Note:** Setting a null value using the `PUT` endpoint retains the key with a null value.
Use this `DELETE` endpoint to fully remove the key if required. For more details, see
[MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133).
operationId: deleteProfileField operationId: deleteProfileField
security: security:
- accessTokenQuery: [] - accessTokenQuery: []
@ -272,9 +270,9 @@ paths:
get: get:
summary: Get this user's profile information. summary: Get this user's profile information.
description: |- description: |-
Retrieve the combined profile information for a user. In addition to the Retrieve the global profile information for a user. In addition to stabilised fields such as
stabilised fields, this API may include custom profile fields as defined in "avatar_url" and "displayname", this API may include custom profile fields.
[MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133). The overall profile data is limited to a maximum of 64 KiB.
operationId: getUserProfile operationId: getUserProfile
parameters: parameters:
- in: path - in: path