Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify formats of string types.
4 changes: 4 additions & 0 deletions data/api/client-server/support.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -66,6 +68,7 @@ paths:
required.
email_address:
type: string
format: email
description: |-
An email address to reach the administrator.

Expand Down Expand Up @@ -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.
Expand Down
5 changes: 4 additions & 1 deletion data/custom-formats.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,7 @@ mx-mxc-uri:
uri:
title: URI
url: http://tools.ietf.org/html/rfc3986
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved
# no regex
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved

email:
title: Email Address
url: https://datatracker.ietf.org/doc/html/rfc5321#section-4.1.2