Accept minor suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
This commit is contained in:
Patrick Cloke 2025-06-13 10:26:20 -04:00 committed by GitHub
parent 6183f2410f
commit 6646146f8c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 15 additions and 12 deletions

View file

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

View file

@ -77,13 +77,13 @@ paths:
$ref: '#/components/schemas/booleanCapability' $ref: '#/components/schemas/booleanCapability'
description: | description: |
**Deprecated:** Capability to indicate if the user can change their display name. **Deprecated:** Capability to indicate if the user can change their display name.
Please refer to `m.profile_fields` for extended profile management. Refer to `m.profile_fields` for extended profile management.
m.set_avatar_url: m.set_avatar_url:
deprecated: true deprecated: true
$ref: '#/components/schemas/booleanCapability' $ref: '#/components/schemas/booleanCapability'
description: | description: |
**Deprecated:** Capability to indicate if the user can change their avatar. **Deprecated:** Capability to indicate if the user can change their avatar.
Please refer to `m.profile_fields` for extended profile management. Refer to `m.profile_fields` for extended profile management.
m.3pid_changes: m.3pid_changes:
$ref: '#/components/schemas/booleanCapability' $ref: '#/components/schemas/booleanCapability'
description: Capability to indicate if the user can change 3PID associations description: Capability to indicate if the user can change 3PID associations
@ -96,8 +96,11 @@ paths:
x-addedInMatrixVersion: "1.14" x-addedInMatrixVersion: "1.14"
type: object type: object
title: ProfileFieldsCapability title: ProfileFieldsCapability
description: Capability to indicate if the user can set or modify extended profile fields. description: Capability to indicate if the user can set or modify extended profile fields via
If absent, clients should assume custom profile fields are supported. [`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.
properties: properties:
allowed: allowed:
type: array type: array
@ -119,7 +122,7 @@ paths:
- "org.example.secret_field" - "org.example.secret_field"
enabled: enabled:
type: boolean 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 example: true
required: required:
- enabled - enabled

View file

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