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

Clarify null behaviour for PUT and DELETE

Browse source
This commit is contained in:
Tom Foster 2025-02-14 11:53:19 +00:00
parent 4f8999be0a
commit 992cf9dc35
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

@ -21,9 +21,11 @@ paths:
summary: Set the user's profile field. summary: Set the user's profile field.
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.
a `null` value SHOULD NOT delete the field. For more details, see
[MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133). **Note:** Setting a `null` value SHOULD NOT delete the field. However, servers MAY reject
requests to store `null` values if they do not allow keys to exist with a `null` value.
For more details, see [MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133).
operationId: setProfileField operationId: setProfileField
security: security:
- accessTokenQuery: [] - accessTokenQuery: []
@ -190,7 +192,10 @@ 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. For more details, see Delete the specified profile field from a user's profile.
**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). [MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133).
operationId: deleteProfileField operationId: deleteProfileField
security: security: