Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-23 19:44:09 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse source 
Co-authored-by: Travis Ralston <travpc@gmail.com>
This commit is contained in:
Kévin Commaille 2024-03-04 09:55:30 +01:00 committed by GitHub
parent 6ca233c8fa
commit a9ae4c2af8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -18,16 +18,16 @@ info:
paths: paths:
/matrix/support: /matrix/support:
get: get:
summary: Gets Matrix server admin contact and support page of the domain. summary: Gets homeserver contacts and support details.
description: |- description: |-
Gets server admin contact and support page of the domain. Gets server admin contact and support page of the domain.
Like the [well-known discovery URI](/client-server-api/#well-known-uri), Like the [well-known discovery URI](/client-server-api/#well-known-uri),
this should be accessed with the hostname of the homeserver, by making a this should be accessed with the hostname of the homeserver by making a
GET request to `https://hostname/.well-known/matrix/support`. GET request to `https://hostname/.well-known/matrix/support`.
Note that this endpoint is not necessarily handled by the homeserver, Note that this endpoint is not necessarily handled by the homeserver.
but by another webserver, to be used for discovering support information It may be served by another webserver, used for discovering support information
for the homeserver. for the homeserver.
operationId: getWellknownSupport operationId: getWellknownSupport
x-addedInMatrixVersion: "1.10" x-addedInMatrixVersion: "1.10"
@ -45,7 +45,7 @@ paths:
Ways to contact the server administrator. Ways to contact the server administrator.
At least one of `contacts` or `support_page` is required. At least one of `contacts` or `support_page` is required.
If only this is set, it must contain at least one item. If only `contacts` is set, it must contain at least one item.
items: items:
type: object type: object
title: Contact title: Contact
@ -54,8 +54,7 @@ paths:
matrix_id: matrix_id:
type: string type: string
description: |- description: |-
A Matrix User ID allowing to contact the A Matrix User ID representing the administrator.
administrator.
It could be an account registered on a different It could be an account registered on a different
homeserver so the administrator can be contacted homeserver so the administrator can be contacted
@ -66,8 +65,7 @@ paths:
email_address: email_address:
type: string type: string
description: |- description: |-
An email address allowing to contact the An email address to reach the administrator.
administrator.
At least one of `matrix_id` or `email_address` is At least one of `matrix_id` or `email_address` is
required. required.
@ -80,7 +78,7 @@ paths:
An informal description of what the contact methods An informal description of what the contact methods
are used for. are used for.
`m.role.admin` is a catch-all user for any queries `m.role.admin` is a catch-all role for any queries
and `m.role.security` is intended for sensitive and `m.role.security` is intended for sensitive
requests. requests.