MSC4133: Update profile endpoints to support extended fields #2071
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Feature: Update profile endpoints to become generic to support [MSC4133](https://github.com/matrix-org/matrix-spec-proposals/pull/4133) extended fields. Extended profile fields are now supported via the new `m.profile_fields` capability, which deprecates the previous `m.set_avatar_url` and `m.set_displayname` capabilities. Stabilised keys are explicitly enumerated, and custom keys must conform to the Common Namespaced Identifier Grammar. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. we could do with corresponding updates to the text sections that describe the capabilites: https://pr2071--matrix-spec-previews.netlify.app/client-server-api/#mset_displayname-capability, https://pr2071--matrix-spec-previews.netlify.app/client-server-api/#mset_avatar_url-capability |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -73,11 +73,17 @@ paths: | |||||||||
| - default | ||||||||||
tcpipuk marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||
| - available | ||||||||||
| m.set_displayname: | ||||||||||
| deprecated: true | ||||||||||
| $ref: '#/components/schemas/booleanCapability' | ||||||||||
| description: | | ||||||||||
| **Deprecated:** Capability to indicate if the user can change their display name. | ||||||||||
| Please refer to `m.profile_fields` for extended profile management. | ||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||
| m.set_avatar_url: | ||||||||||
| deprecated: true | ||||||||||
| $ref: '#/components/schemas/booleanCapability' | ||||||||||
| description: | | ||||||||||
| **Deprecated:** Capability to indicate if the user can change their avatar. | ||||||||||
| Please refer to `m.profile_fields` for extended profile management. | ||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||
| m.3pid_changes: | ||||||||||
| $ref: '#/components/schemas/booleanCapability' | ||||||||||
| description: Capability to indicate if the user can change 3PID associations | ||||||||||
|
|
@@ -86,6 +92,37 @@ paths: | |||||||||
| $ref: '#/components/schemas/booleanCapability' | ||||||||||
| description: Capability to indicate if the user can generate tokens to log further | ||||||||||
| clients into their account. | ||||||||||
| m.profile_fields: | ||||||||||
| x-addedInMatrixVersion: "1.14" | ||||||||||
| type: object | ||||||||||
| title: ProfileFieldsCapability | ||||||||||
| description: Capability to indicate if the user can set or modify extended profile fields. | ||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||
| If absent, clients should assume custom profile fields are supported. | ||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||
| properties: | ||||||||||
| allowed: | ||||||||||
| type: array | ||||||||||
| description: List of allowed additional custom profile field keys. A `*` can be used as a | ||||||||||
|
There was a problem hiding this comment. oh, |
||||||||||
| wildcard to match any sequence of characters. This list takes precedence over the | ||||||||||
|
Comment on lines
+104
to
+105
There was a problem hiding this comment.
Wait, where did this come from? This wasn't in the MSC, was it? Wildcarding opens up a whole new set of questions that I don't think we want to deal with. |
||||||||||
| disallowed list if both are provided. | ||||||||||
| items: | ||||||||||
| type: string | ||||||||||
| example: | ||||||||||
| - "m.example_field" | ||||||||||
| - "org.example/job_title" | ||||||||||
|
There was a problem hiding this comment. this doesn't look like a valid Common Namespaced Identifier Grammar identifier, and is therefore not a great example? |
||||||||||
| disallowed: | ||||||||||
| type: array | ||||||||||
| description: List of disallowed additional custom profile field keys. A `*` can be used as | ||||||||||
| a wildcard to match any sequence of characters. Ignored if an allowed list is provided. | ||||||||||
| items: | ||||||||||
| type: string | ||||||||||
| example: | ||||||||||
| - "org.example.secret_field" | ||||||||||
| enabled: | ||||||||||
| type: boolean | ||||||||||
| description: True if the user can set or modify any extended profile fields, false otherwise. | ||||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||||
| example: true | ||||||||||
| required: | ||||||||||
| - enabled | ||||||||||
| examples: | ||||||||||
| response: | ||||||||||
| value: { | ||||||||||
|
|
||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can see this has gone through a bit of iteration, so apologies for the back-and-forth, but honestly this feels rather wordy for a changelog entry. Take a look at the examples in https://spec.matrix.org/v1.14/changelog/v1.14/ (and previous versions): there are very few that run to more than a single sentence; if people want more details about what's actually changing they can easily click through to the PR; and the body of the spec contains "Changed in v1.14" notes.
I think a good trick here would be to have two separate changelog entries; so here, we want something like:
... and then in
changelogs/client_server/newsfragments/2071.deprecation, we want: