Clarify that additional OpenGraph properties can be present in URL previews (#2225)

Fixes: #1753

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
pull/2229/head
Johannes Marbach 2 months ago committed by GitHub
parent b6a127b5cb
commit f82d8ab15b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

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

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

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

Loading…
Cancel
Save