From cae56bc78695ebfe29fbf8b1f22c83afc4ad5018 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?K=C3=A9vin=20Commaille?= <zecakeh@tedomum.fr>
Date: Tue, 15 Oct 2024 12:23:37 +0200
Subject: [PATCH] Clarify formats of string types for the `GET
 /.well-known/matrix/support` endpoint
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
---
 data/api/client-server/support.yaml | 4 ++++
 data/custom-formats.yaml            | 5 ++++-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/data/api/client-server/support.yaml b/data/api/client-server/support.yaml
index 1598d5d7..b9ca062e 100644
--- a/data/api/client-server/support.yaml
+++ b/data/api/client-server/support.yaml
@@ -54,6 +54,8 @@ paths:
                       properties:
                         matrix_id:
                           type: string
+                          format: mx-user-id
+                          pattern: "^@"
                           description: |-
                             A [Matrix User ID](/appendices/#user-identifiers)
                             representing the administrator.
@@ -66,6 +68,7 @@ paths:
                             required.
                         email_address:
                           type: string
+                          format: email
                           description: |-
                             An email address to reach the administrator.
 
@@ -95,6 +98,7 @@ paths:
                       }
                   support_page:
                     type: string
+                    format: uri
                     description: |-
                       The URL of a page to give users help specific to the
                       homeserver, like extra login/registration steps.
diff --git a/data/custom-formats.yaml b/data/custom-formats.yaml
index 7d52861f..b328feab 100644
--- a/data/custom-formats.yaml
+++ b/data/custom-formats.yaml
@@ -50,4 +50,7 @@ mx-mxc-uri:
 uri:
   title: URI
   url: http://tools.ietf.org/html/rfc3986
-  # no regex
+
+email:
+  title: Email Address
+  url: https://datatracker.ietf.org/doc/html/rfc5321#section-4.1.2