Merge 0bc02c7c69 into c8380d9552

Add format query parameter to GET /state/{eventType}/{stateKey} (#2175 )
doc(changelog): details the CI build-openapi update
2026-04-29 22:04:08 +02:00 · 2025-07-21 11:07:20 +01:00 · 2025-07-19 22:52:41 +03:00 · 2025-07-08 17:25:58 +02:00 · 2025-07-08 16:22:07 +02:00 · 2025-07-08 12:08:19 +02:00
4 changed files with 27 additions and 2 deletions
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@ -155,6 +155,11 @@ jobs:
              --api server-server \
              -r "$RELEASE" \
              -o spec/server-server-api/api.json
+          scripts/dump-openapi.py \
+              --base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \
+              --api identity \
+              -r "$RELEASE" \
+              -o spec/identity-service-api/api.json
          tar -czf openapi.tar.gz spec
      - name: "📤 Artifact upload"
        uses: actions/upload-artifact@v4
--- a/changelogs/client_server/newsfragments/2175.feature
+++ b/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.
--- a/changelogs/internal/newsfragments/2172.clarification
+++ b/changelogs/internal/newsfragments/2172.clarification
@ -0,0 +1 @@
+GitHub actions are now building the OpenAPI `spec/identity-service-api/api.json` file.
--- a/data/api/client-server/rooms.yaml
+++ b/data/api/client-server/rooms.yaml
@ -105,13 +105,31 @@ paths:
          example: ""
          schema:
            type: string
+        - in: query
+          name: format
+          x-addedInMatrixVersion: "1.16"
+          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: {
Author	SHA1	Message	Date
Pierre 'McFly' Marty	3d48e9820c	Merge `0bc02c7c69` into `c8380d9552`	2025-07-21 11:07:20 +01:00
Tulir Asokan	c8380d9552	Add `format` query parameter to `GET /state/{eventType}/{stateKey}` (#2175 ) 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-07-19 22:52:41 +03:00
Pierre 'McFly' Marty	0bc02c7c69	doc(changelog): details the CI `build-openapi` update Signed-off-by: Pierre 'McFly' Marty <pmarty@linagora.com>	2025-07-08 17:25:58 +02:00
Pierre 'McFly' Marty	ebc9cc7aa6	chore(build-openapi): fixes typo in artifacts folder name Signed-off-by: Pierre 'McFly' Marty <pmarty@linagora.com>	2025-07-08 16:22:07 +02:00
Pierre 'McFly' Marty	5cf3c35c2d	ci(build-openapi): indentity routes were missing Signed-off-by: Pierre 'McFly' Marty <pmarty@linagora.com>	2025-07-08 12:08:19 +02:00
				`@ -0,0 +1 @@`
				Add `format` query parameter to `GET /state/{eventType}/{stateKey}` to allow fetching metadata of a specific state event.
				`@ -0,0 +1 @@`
				GitHub actions are now building the OpenAPI `spec/identity-service-api/api.json` file.