Clarify formats of string types for the `GET /.well-known/matrix/supp…

…ort` endpoint Signed-off-by: Kévin Commaille <[email protected]>
matrix-org · Oct 15, 2024 · cae56bc · cae56bc
1 parent 69d7dbf
commit cae56bc
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git 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
@@ -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