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

Link to MSC4133 in endpoint descriptions

Browse source
This commit is contained in:
Tom Foster 2025-02-14 10:40:09 +00:00
parent b2e122f308
commit 59d2c62d2d
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -22,7 +22,8 @@ paths:
description: |- description: |-
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. Note that setting appropriate permissions (i.e. an access token) to modify the profile field. Note that setting
a `null` value SHOULD NOT delete the field. a `null` value SHOULD NOT delete the field. For more details, see
[MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133).
operationId: setProfileField operationId: setProfileField
security: security:
- accessTokenQuery: [] - accessTokenQuery: []
@ -108,7 +109,8 @@ paths:
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 can retrieve the profile fields of the user
or other users, either locally or on remote homeservers. It supports both standard fields or other users, either locally or on remote homeservers. It supports both standard fields
(e.g. "displayname" and "avatar_url") and custom keys. (e.g. "displayname" and "avatar_url") and custom keys. For more details, see
[MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133).
operationId: getProfileField operationId: getProfileField
parameters: parameters:
- in: path - in: path
@ -164,7 +166,9 @@ paths:
- User data - User data
delete: delete:
summary: Delete a profile field. summary: Delete a profile field.
description: Delete the specified profile field from a user's profile. description: |-
Delete the specified profile field from a user's profile. For more details, see
[MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133).
operationId: deleteProfileField operationId: deleteProfileField
security: security:
- accessTokenQuery: [] - accessTokenQuery: []
@ -237,7 +241,8 @@ paths:
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 standard fields, Retrieve the combined profile information for a user. In addition to the standard fields,
this API may include extended custom profile fields as defined in MSC4133. this API may include extended custom profile fields as defined in
[MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133).
operationId: getUserProfile operationId: getUserProfile
parameters: parameters:
- in: path - in: path