wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Clarify formats of string types for the GET /.well-known/matrix/support endpoint (#1978)

Browse source
This commit is contained in:
Kévin Commaille 2024-11-06 16:16:34 +01:00 • committed by GitHub
parent 6cd7038d01
commit 909c4614ac
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/1978.clarification Normal file
View file

@ -0,0 +1 @@
Clarify formats of string types.

4
data/api/client-server/support.yaml
View file

@ -54,6 +54,8 @@ paths:
properties: properties:
matrix_id: matrix_id:
type: string type: string
format: mx-user-id
pattern: "^@"
description: |- description: |-
A [Matrix User ID](/appendices/#user-identifiers) A [Matrix User ID](/appendices/#user-identifiers)
representing the administrator. representing the administrator.
@ -66,6 +68,7 @@ paths:
required. required.
email_address: email_address:
type: string type: string
format: email
description: |- description: |-
An email address to reach the administrator. An email address to reach the administrator.
@ -95,6 +98,7 @@ paths:
} }
support_page: support_page:
type: string type: string
format: uri
description: |- description: |-
The URL of a page to give users help specific to the The URL of a page to give users help specific to the
homeserver, like extra login/registration steps. homeserver, like extra login/registration steps.

4
data/string-formats.yaml
View file

@ -64,3 +64,7 @@ mx-mxc-uri:
uri: uri:
title: URI title: URI
url: https://datatracker.ietf.org/doc/html/rfc3986 url: https://datatracker.ietf.org/doc/html/rfc3986
email:
title: Email Address
url: https://datatracker.ietf.org/doc/html/rfc5321#section-4.1.2