Clarify that additional OpenGraph properties can be present in URL previews (#2225)
Some checks are pending
Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run
Spec / 🔎 Check Event schema examples (push) Waiting to run
Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run
Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run
Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run
Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions
Spec / 📢 Run towncrier for changelog (push) Waiting to run
Spec / 📖 Build the spec (push) Blocked by required conditions
Spec / 🔎 Validate generated HTML (push) Blocked by required conditions
Spec / 📖 Build the historical backup spec (push) Blocked by required conditions
Spell Check / Spell Check with Typos (push) Waiting to run

Fixes: #1753

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
Johannes Marbach 2025-10-07 10:44:20 +02:00 committed by GitHub
parent b6a127b5cb
commit f82d8ab15b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 11 additions and 2 deletions

View file

@ -0,0 +1 @@
Additional OpenGraph properties can be present in URL previews.

View file

@ -379,7 +379,8 @@ paths:
description: |- description: |-
The OpenGraph data for the URL, which may be empty. Some values are The OpenGraph data for the URL, which may be empty. Some values are
replaced with matrix equivalents if they are provided in the response. replaced with matrix equivalents if they are provided in the response.
The differences from the OpenGraph protocol are described here. The differences from the [OpenGraph protocol](https://ogp.me/) are
described here.
content: content:
application/json: application/json:
schema: schema:
@ -394,6 +395,9 @@ paths:
format: uri format: uri
description: An [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris) to description: An [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris) to
the image. Omitted if there is no image. the image. Omitted if there is no image.
additionalProperties:
description: |-
Additional properties as per the [OpenGraph](https://ogp.me/) protocol.
examples: examples:
response: response:
value: { value: {

View file

@ -605,7 +605,8 @@ paths:
description: |- description: |-
The OpenGraph data for the URL, which may be empty. Some values are The OpenGraph data for the URL, which may be empty. Some values are
replaced with matrix equivalents if they are provided in the response. replaced with matrix equivalents if they are provided in the response.
The differences from the OpenGraph protocol are described here. The differences from the [OpenGraph](https://ogp.me/) protocol are
described here.
content: content:
application/json: application/json:
schema: schema:
@ -620,6 +621,9 @@ paths:
format: uri format: uri
description: An [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris) to description: An [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris) to
the image. Omitted if there is no image. the image. Omitted if there is no image.
additionalProperties:
description: |-
Additional properties as per the [OpenGraph](https://ogp.me/) protocol.
examples: examples:
response: response:
value: { value: {