Compare commits

..

1 commit

Author SHA1 Message Date
Tom Foster 206704781e
Merge 6183f2410f into a2a9a02efa 2025-06-12 15:58:33 -04:00
3 changed files with 12 additions and 15 deletions

View file

@ -63,7 +63,7 @@ for sending events:
The following API endpoints are allowed to be accessed by guest accounts
for their own account maintenance:
* [PUT /profile/{userId}/{keyName}](#put_matrixclientv3profileuseridkeyname)
* [PUT /profile/{userId}/{key_name}](#put_matrixclientv3profileuseridkeyname)
* [GET /devices](#get_matrixclientv3devices)
* [GET /devices/{deviceId}](#get_matrixclientv3devicesdeviceid)
* [PUT /devices/{deviceId}](#put_matrixclientv3devicesdeviceid)

View file

@ -77,13 +77,13 @@ paths:
$ref: '#/components/schemas/booleanCapability'
description: |
**Deprecated:** Capability to indicate if the user can change their display name.
Refer to `m.profile_fields` for extended profile management.
Please refer to `m.profile_fields` for extended profile management.
m.set_avatar_url:
deprecated: true
$ref: '#/components/schemas/booleanCapability'
description: |
**Deprecated:** Capability to indicate if the user can change their avatar.
Refer to `m.profile_fields` for extended profile management.
Please refer to `m.profile_fields` for extended profile management.
m.3pid_changes:
$ref: '#/components/schemas/booleanCapability'
description: Capability to indicate if the user can change 3PID associations
@ -96,11 +96,8 @@ paths:
x-addedInMatrixVersion: "1.14"
type: object
title: ProfileFieldsCapability
description: Capability to indicate if the user can set or modify extended profile fields via
[`PUT /_matrix/client/v3/profile/{userId}/{keyName}`](/client-server-api/#put_matrixclientv3profileuseridkeyname).
If absent, clients should assume custom profile fields are supported, provided the
response from [`/versions`](/client-server-api/#get_matrixclientversions) indicates
support for a sufficiently recent spec version.
description: Capability to indicate if the user can set or modify extended profile fields.
If absent, clients should assume custom profile fields are supported.
properties:
allowed:
type: array
@ -122,7 +119,7 @@ paths:
- "org.example.secret_field"
enabled:
type: boolean
description: `true` if the user can set or modify any extended profile fields, `false` otherwise.
description: True if the user can set or modify any extended profile fields, false otherwise.
example: true
required:
- enabled

View file

@ -23,8 +23,8 @@ paths:
summary: Set a profile field for a user.
description: |-
Set or update a profile field for a user. Must be authenticated with an
access token authorised to make changes. Servers MAY impose size limits
on individual fields, and the total profile MUST be under 64 KiB.
access token authorised to make changes. Servers may impose size limits
on individual fields, and the total profile must be under 64 KiB.
**Note**: Setting a field to `null` keeps the key but with a `null` value,
which some servers may reject. To remove a field completely, use the
@ -36,7 +36,7 @@ paths:
parameters:
- in: path
name: userId
description: The user whose profile field should be set.
description: The user whose profile field to set.
required: true
example: "@alice:example.com"
schema:
@ -133,7 +133,7 @@ paths:
parameters:
- in: path
name: userId
description: The user whose profile field should be returned.
description: The user whose profile field to get.
required: true
example: "@alice:example.com"
schema:
@ -196,14 +196,14 @@ paths:
parameters:
- in: path
name: userId
description: The user whose profile field should be deleted.
description: The user whose profile field to delete.
required: true
example: "@alice:example.com"
schema:
type: string
- in: path
name: keyName
description: The key name of the profile field to delete. It must be either
description: The profile field key name to delete. It must be either
`avatar_url`, `displayname`, or a custom field following the
[Common Namespaced Identifier Grammar](/appendices/#common-namespaced-identifier-grammar).
required: true