Merge 92084268f1 into 32b1f0514d

Clarify some string formats of room summary endpoint (#2158 )
Add newsfragment
2026-02-24 23:13:42 +01:00 · 2025-06-10 18:24:12 +01:00 · 2025-06-07 15:26:56 +02:00 · 2025-04-09 10:39:45 +02:00 · 2025-04-09 10:39:37 +02:00
7 changed files with 18 additions and 1 deletions
--- a/changelogs/application_service/newsfragments/2132.clarification
+++ b/changelogs/application_service/newsfragments/2132.clarification
@ -0,0 +1 @@
+Declare the Application Service Registration schema to follow JSON Schema spec 2020-12.
--- a/changelogs/client_server/newsfragments/2158.feature
+++ b/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).
--- a/data/api/application-service/definitions/namespace_list.yaml
+++ b/data/api/application-service/definitions/namespace_list.yaml
@ -11,6 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+$schema: https://json-schema.org/draft/2020-12/schema

 type: array
 items:
--- a/data/api/application-service/definitions/registration.yaml
+++ b/data/api/application-service/definitions/registration.yaml
@ -11,6 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+$schema: https://json-schema.org/draft/2020-12/schema

 type: object
 title: Registration
--- a/data/api/client-server/definitions/public_rooms_chunk.yaml
+++ b/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:
--- a/data/api/client-server/definitions/room_summary.yaml
+++ b/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.
--- a/data/api/client-server/room_summary.yaml
+++ b/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.
Author	SHA1	Message	Date
V02460	d31010f4e5	Merge `92084268f1` into `32b1f0514d`	2025-06-10 18:24:12 +01:00
Kévin Commaille	32b1f0514d	Clarify some string formats of room summary endpoint (#2158 ) Some checks failed Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled Details Spec / 🔎 Check Event schema examples (push) Has been cancelled Details Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled Details Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled Details Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled Details Spec / 📢 Run towncrier for changelog (push) Has been cancelled Details Spell Check / Spell Check with Typos (push) Has been cancelled Details Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled Details Spec / 📖 Build the spec (push) Has been cancelled Details Spec / 🔎 Validate generated HTML (push) Has been cancelled Details Spec / 📖 Build the historical backup spec (push) Has been cancelled Details	2025-06-07 15:26:56 +02:00
Kai A. Hiller	92084268f1	Add newsfragment Signed-off-by: Kai A. Hiller <git@kaialexhiller.de>	2025-04-09 10:39:45 +02:00
Kai A. Hiller	6ae25e7df4	Add meta schema to AS registration schema Signed-off-by: Kai A. Hiller <git@kaialexhiller.de>	2025-04-09 10:39:37 +02:00
				`@ -0,0 +1 @@`
				`Declare the Application Service Registration schema to follow JSON Schema spec 2020-12.`
				`@ -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).