From 89b62de53a9261ffc0c1b6e384517b920b091aae Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 7 Oct 2025 10:23:39 +0200 Subject: [PATCH] Clarify that additional OpenGraph properties can be present in URL previews Fixes: #1753 Signed-off-by: Johannes Marbach --- changelogs/client_server/newsfragments/2225.clarification | 1 + data/api/client-server/authed-content-repo.yaml | 6 +++++- data/api/client-server/content-repo.yaml | 6 +++++- 3 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 changelogs/client_server/newsfragments/2225.clarification diff --git a/changelogs/client_server/newsfragments/2225.clarification b/changelogs/client_server/newsfragments/2225.clarification new file mode 100644 index 00000000..6a62eb99 --- /dev/null +++ b/changelogs/client_server/newsfragments/2225.clarification @@ -0,0 +1 @@ +Additional OpenGraph properties can be present in URL previews. diff --git a/data/api/client-server/authed-content-repo.yaml b/data/api/client-server/authed-content-repo.yaml index 53416cf3..4d5b6582 100644 --- a/data/api/client-server/authed-content-repo.yaml +++ b/data/api/client-server/authed-content-repo.yaml @@ -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: { diff --git a/data/api/client-server/content-repo.yaml b/data/api/client-server/content-repo.yaml index c64a914b..38b6e6fd 100644 --- a/data/api/client-server/content-repo.yaml +++ b/data/api/client-server/content-repo.yaml @@ -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: {