Merge 59212cf842 into 32b1f0514d

Suggest how to number the draft before user have the PR/MSC ID, referring to the other guide.

changelogs/client_server/newsfragments/2158.feature

@@ -0,0 +1 @@
+Add `/_matrix/client/v1/room_summary/{roomIdOrAlias}` and extend `/_matrix/client/v1/rooms/{roomId}/hierarchy` with the new optional properties `allowed_room_ids`, `encryption` and `room_version` as per [MSC3266](https://github.com/matrix-org/matrix-spec-proposals/pull/3266).

content/proposals.md

@@ -185,6 +185,10 @@ is as follows:
     -   Take care in creating your proposal. Specify your intended
         changes, and give reasoning to back them up. Changes without
         justification will likely be poorly received by the community.
+    -   At the time of creating your draft there is no PR ID, so you
+        should use a placeholder number to name your file and edit that
+        after PR submission, the suggested steps are described in
+        detail [in the proposals guide](https://github.com/matrix-org/matrix-spec-proposals#1-writing-the-proposal).
 -   Fork and make a PR to the
     [matrix-spec-proposals](https://github.com/matrix-org/matrix-spec-proposals) repository.
     The ID of your PR will become the MSC ID for the lifetime of your

data/api/client-server/definitions/public_rooms_chunk.yaml

@@ -17,6 +17,8 @@ title: "PublishedRoomsChunk"
 properties:
   canonical_alias:
     type: string
+    format: mx-room-alias
+    pattern: "^#"
     description: The canonical alias of the room, if any.
     example: "#general:example.org"
   name:
@@ -29,6 +31,8 @@ properties:
     example: 42
   room_id:
     type: string
+    format: mx-room-id
+    pattern: "^!"
     description: The ID of the room.
     example: "!abcdefg:example.org"
   topic:

data/api/client-server/definitions/room_summary.yaml

@@ -27,6 +27,8 @@ allOf:
         type: array
         items:
           type: string
+          format: mx-room-id
+          pattern: "^!"
         description: |-
           If the room is a [restricted room](/server-server-api/#restricted-rooms), these are the room IDs which
           are specified by the join rules. Empty or omitted otherwise.

data/api/client-server/room_summary.yaml

@@ -46,7 +46,13 @@ paths:
           required: true
           example: "#monkeys:matrix.org"
           schema:
-            type: string
+            oneOf:
+              - type: string
+                format: mx-room-id
+                pattern: "^!"
+              - type: string
+                format: mx-room-alias
+                pattern: "^#"
         - in: query
           name: via
           description: |-
@@ -60,6 +66,7 @@ paths:
             type: array
             items:
               type: string
+              format: mx-server-name
       responses:
         "200":
           description: A summary of the room.