Clarify that additional OpenGraph properties can be present in URL previews

Fixes: #1753
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
pull/2225/head
Johannes Marbach 2 months ago
parent b6a127b5cb
commit 89b62de53a

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

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

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

Loading…
Cancel
Save