Clarify that format is required if formatted_body is specified (#2167)
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
Johannes Marbach 2025-07-15 10:47:50 +02:00 committed by GitHub
parent 0e280ed014
commit 3877598b1e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 17 additions and 16 deletions

View file

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

View file

@ -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:

View file

@ -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: |-

View file

@ -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:

View file

@ -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:

View file

@ -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: |-

View file

@ -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: |-

View file

@ -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: |-

View file

@ -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: