Merge c4bbef30d1 into 3877598b1e

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>

changelogs/client_server/newsfragments/2167.clarification

@@ -0,0 +1 @@
+Clarify that `format` is required if `formatted_body` is specified.

changelogs/client_server/newsfragments/2175.feature

@@ -0,0 +1 @@
+Add `format` query parameter to `GET /state/{eventType}/{stateKey}` to allow fetching metadata of a specific state event.

data/api/client-server/rooms.yaml

@@ -105,13 +105,30 @@ paths:
           example: ""
           schema:
             type: string
+        - in: query
+          name: format
+          description: |-
+            The format to use for the returned data. `content` (the default) will
+            return only the content of the state event. `event` will return the entire
+            event in the usual format suitable for clients, including fields like event
+            ID, sender and timestamp.
+          example: event
+          schema:
+            type: string
+            enum:
+            - content
+            - event
       responses:
         "200":
-          description: The content of the state event.
+          description: |-
+            The content of the state event, or the entire client-formatted event
+            if `?format=event` was used.
           content:
             application/json:
               schema:
-                type: object
+                oneOf:
+                  - type: object
+                  - $ref: "../../event-schemas/schema/core-event-schema/state_event.yaml"
               examples:
                 response:
                   value: {

data/event-schemas/schema/m.room.message$m.audio.yaml

@@ -15,8 +15,8 @@ properties:
           "1.10": This property can act as a caption for the audio.
       format:
         description: |-
-          The format used in the `formatted_body`. Currently only
+          The format used in the `formatted_body`. This is required if `formatted_body`
-          `org.matrix.custom.html` is supported.
+          is specified. Currently only `org.matrix.custom.html` is supported.
         type: string
         x-addedInMatrixVersion: "1.10"
       formatted_body:

data/event-schemas/schema/m.room.message$m.emote.yaml

@@ -14,8 +14,8 @@ properties:
         type: string
       format:
         description: |-
-          The format used in the `formatted_body`. Currently only
+          The format used in the `formatted_body`. This is required if `formatted_body`
-          `org.matrix.custom.html` is supported.
+          is specified. Currently only `org.matrix.custom.html` is supported.
         type: string
       formatted_body:
         description: |-

data/event-schemas/schema/m.room.message$m.file.yaml

@@ -15,8 +15,8 @@ properties:
           "1.10": This property can act as a caption for the file.
       format:
         description: |-
-          The format used in the `formatted_body`. Currently only
+          The format used in the `formatted_body`. This is required if `formatted_body`
-          `org.matrix.custom.html` is supported.
+          is specified. Currently only `org.matrix.custom.html` is supported.
         type: string
         x-addedInMatrixVersion: "1.10"
       formatted_body:

data/event-schemas/schema/m.room.message$m.image.yaml

@@ -15,8 +15,8 @@ properties:
           "1.10": This property can act as a caption for the image.
       format:
         description: |-
-          The format used in the `formatted_body`. Currently only
+          The format used in the `formatted_body`. This is required if `formatted_body`
-          `org.matrix.custom.html` is supported.
+          is specified. Currently only `org.matrix.custom.html` is supported.
         type: string
         x-addedInMatrixVersion: "1.10"
       formatted_body:

data/event-schemas/schema/m.room.message$m.key.verification.request.yaml

@@ -22,8 +22,8 @@ properties:
           verification.
       format:
         description: |-
-          The format used in the `formatted_body`. Currently only
+          The format used in the `formatted_body`. This is required if `formatted_body`
-          `org.matrix.custom.html` is supported.
+          is specified. Currently only `org.matrix.custom.html` is supported.
         type: string
       formatted_body:
         description: |-

data/event-schemas/schema/m.room.message$m.notice.yaml

@@ -14,8 +14,8 @@ properties:
         type: string
       format:
         description: |-
-          The format used in the `formatted_body`. Currently only
+          The format used in the `formatted_body`. This is required if `formatted_body`
-          `org.matrix.custom.html` is supported.
+          is specified. Currently only `org.matrix.custom.html` is supported.
         type: string
       formatted_body:
         description: |-

data/event-schemas/schema/m.room.message$m.text.yaml

@@ -14,8 +14,8 @@ properties:
         type: string
       format:
         description: |-
-          The format used in the `formatted_body`. Currently only
+          The format used in the `formatted_body`. This is required if `formatted_body`
-          `org.matrix.custom.html` is supported.
+          is specified. Currently only `org.matrix.custom.html` is supported.
         type: string
       formatted_body:
         description: |-

data/event-schemas/schema/m.room.message$m.video.yaml

@@ -15,8 +15,8 @@ properties:
           "1.10": This property can act as a caption for the video.
       format:
         description: |-
-          The format used in the `formatted_body`. Currently only
+          The format used in the `formatted_body`. This is required if `formatted_body`
-          `org.matrix.custom.html` is supported.
+          is specified. Currently only `org.matrix.custom.html` is supported.
         type: string
         x-addedInMatrixVersion: "1.10"
       formatted_body: