Add missing references in capabilities table (#1897)

* Add missing references in capabilities table Fixes: #1548 Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org> * Add changelog --------- Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
matrix-org · Jul 10, 2024 · 40d5e48 · 40d5e48
1 parent b1349dd
commit 40d5e48
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 9 deletions.
diff --git a/changelogs/client_server/newsfragments/1897.clarification b/changelogs/client_server/newsfragments/1897.clarification
@@ -0,0 +1 @@
+Add missing references to `m.set_displayname`, `m.set_avatar_url` and `m.3pid_changes` in capabilities table.
diff --git a/data/api/client-server/capabilities.yaml b/data/api/client-server/capabilities.yaml
@@ -46,16 +46,8 @@ paths:
                       type: object
                     properties:
                       m.change_password:
-                        type: object
+                        $ref: '#/components/schemas/booleanCapability'
                         description: Capability to indicate if the user can change their password.
-                        title: ChangePasswordCapability
-                        properties:
-                          enabled:
-                            type: boolean
-                            description: True if the user can change their password, false otherwise.
-                            example: false
-                        required:
-                          - enabled
                       m.room_versions:
                         type: object
                         description: The room versions the server supports.
@@ -78,6 +70,16 @@ paths:
                         required:
                           - default
                           - available
+                      m.set_displayname:
+                        $ref: '#/components/schemas/booleanCapability'
+                        description: Capability to indicate if the user can change their display name.
+                      m.set_avatar_url:
+                        $ref: '#/components/schemas/booleanCapability'
+                        description: Capability to indicate if the user can change their avatar.
+                      m.3pid_changes:
+                        $ref: '#/components/schemas/booleanCapability'
+                        description: Capability to indicate if the user can change 3PID associations
+                          on their account.
               examples:
                 response:
                   value: {
@@ -125,3 +127,14 @@ components:
       $ref: definitions/security.yaml#/accessTokenQuery
     accessTokenBearer:
       $ref: definitions/security.yaml#/accessTokenBearer
+  schemas:
+    booleanCapability:
+      type: object
+      title: BooleanCapability
+      properties:
+        enabled:
+          type: boolean
+          description: True if the user can perform the action, false otherwise.
+          example: false
+      required:
+        - enabled