Merge 0bc02c7c69 into 3877598b1e

Clarify that format is required if formatted_body is specified (#2167 )
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-05-01 14:44:09 +02:00 · 2025-07-18 13:53:31 +01:00 · 2025-07-15 11:47:50 +03:00 · 2025-07-14 14:09:08 +03:00 · 2025-07-08 17:25:58 +02:00 · 2025-07-08 16:22:07 +02:00
13 changed files with 25 additions and 17 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/2167.clarification
+++ b/changelogs/client_server/newsfragments/2167.clarification
@ -0,0 +1 @@
+Clarify that `format` is required if `formatted_body` is specified.
--- a/changelogs/client_server/newsfragments/2177.clarification
+++ b/changelogs/client_server/newsfragments/2177.clarification
@ -0,0 +1 @@
+Fix various typos throughout the specification.
--- 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/logout.yaml
+++ b/data/api/client-server/logout.yaml
@ -47,7 +47,7 @@ paths:
        deleted alongside the device.

        This endpoint does not use the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api) because
-        User-Interactive Authentication is designed to protect against attacks where the
+        User-Interactive Authentication is designed to protect against attacks where
        someone gets hold of a single access token then takes over the account. This
        endpoint invalidates all access tokens for the user, including the token used in
        the request, and therefore the attacker is unable to take over the account in
--- a/data/event-schemas/schema/m.room.message$m.audio.yaml
+++ b/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
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
        x-addedInMatrixVersion: "1.10"
      formatted_body:
--- a/data/event-schemas/schema/m.room.message$m.emote.yaml
+++ b/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
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
      formatted_body:
        description: |-
--- a/data/event-schemas/schema/m.room.message$m.file.yaml
+++ b/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
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
        x-addedInMatrixVersion: "1.10"
      formatted_body:
--- a/data/event-schemas/schema/m.room.message$m.image.yaml
+++ b/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
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
        x-addedInMatrixVersion: "1.10"
      formatted_body:
--- a/data/event-schemas/schema/m.room.message$m.key.verification.request.yaml
+++ b/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
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
      formatted_body:
        description: |-
--- a/data/event-schemas/schema/m.room.message$m.notice.yaml
+++ b/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
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
      formatted_body:
        description: |-
--- a/data/event-schemas/schema/m.room.message$m.text.yaml
+++ b/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
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
      formatted_body:
        description: |-
--- a/data/event-schemas/schema/m.room.message$m.video.yaml
+++ b/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
-          `org.matrix.custom.html` is supported.
+          The format used in the `formatted_body`. This is required if `formatted_body`
+          is specified. Currently only `org.matrix.custom.html` is supported.
        type: string
        x-addedInMatrixVersion: "1.10"
      formatted_body:
Author	SHA1	Message	Date
Pierre 'McFly' Marty	7db34e1089	Merge `0bc02c7c69` into `3877598b1e`	2025-07-18 13:53:31 +01:00
Johannes Marbach	3877598b1e	Clarify that format is required if formatted_body is specified (#2167 ) 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 Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>	2025-07-15 11:47:50 +03:00
Johannes Marbach	0e280ed014	Fix typo (#2177 ) Some checks are pending Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run Details Spec / 🔎 Check Event schema examples (push) Waiting to run Details Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run Details Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run Details Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run Details Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions Details Spec / 📢 Run towncrier for changelog (push) Waiting to run Details Spec / 📖 Build the spec (push) Blocked by required conditions Details Spec / 🔎 Validate generated HTML (push) Blocked by required conditions Details Spec / 📖 Build the historical backup spec (push) Blocked by required conditions Details Spell Check / Spell Check with Typos (push) Waiting to run Details Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>	2025-07-14 14:09:08 +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 @@`
				Clarify that `format` is required if `formatted_body` is specified.
				`@ -0,0 +1 @@`
				`Fix various typos throughout the specification.`
				`@ -0,0 +1 @@`
				GitHub actions are now building the OpenAPI `spec/identity-service-api/api.json` file.