Merge 92084268f1 into 3877598b1e

Clarify that format is required if formatted_body is specified (#2167 )
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-04-19 09:34:09 +02:00 · 2025-07-15 10:52:34 +02:00 · 2025-07-15 11:47:50 +03:00 · 2025-04-09 10:39:45 +02:00 · 2025-04-09 10:39:37 +02:00
12 changed files with 20 additions and 16 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/2167.clarification
+++ b/changelogs/client_server/newsfragments/2167.clarification
@ -0,0 +1 @@
+Clarify that `format` is required if `formatted_body` is specified.
--- 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/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
V02460	11ed2632d2	Merge `92084268f1` into `3877598b1e`	2025-07-15 10:52:34 +02: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
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 @@`
				Clarify that `format` is required if `formatted_body` is specified.