Merge dcdfd84f27 into f82d8ab15b

Clarify that additional OpenGraph properties can be present in URL previews (#2225 )
Fixes: #1753 Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2026-03-13 23:14:10 +01:00 · 2025-10-07 11:51:43 +01:00 · 2025-10-07 10:44:20 +02:00
3 changed files with 11 additions and 2 deletions
--- a/changelogs/client_server/newsfragments/2225.clarification
+++ b/changelogs/client_server/newsfragments/2225.clarification
@ -0,0 +1 @@
+Additional OpenGraph properties can be present in URL previews.
--- 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: {
--- 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: {
Author	SHA1	Message	Date
Hugh Nimmo-Smith	5597ec22fb	Merge `dcdfd84f27` into `f82d8ab15b`	2025-10-07 11:51:43 +01:00
Johannes Marbach	f82d8ab15b	Clarify that additional OpenGraph properties can be present in URL previews (#2225 ) Some checks are pending Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run Details Spec / 🔎 Check Event schema examples (push) Waiting to run Details Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run Details Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run Details Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run Details Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions Details Spec / 📢 Run towncrier for changelog (push) Waiting to run Details Spec / 📖 Build the spec (push) Blocked by required conditions Details Spec / 🔎 Validate generated HTML (push) Blocked by required conditions Details Spec / 📖 Build the historical backup spec (push) Blocked by required conditions Details Spell Check / Spell Check with Typos (push) Waiting to run Details Fixes: #1753 Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>	2025-10-07 10:44:20 +02:00
				`@ -0,0 +1 @@`
				`Additional OpenGraph properties can be present in URL previews.`