Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-04-11 05:44:08 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

f

Browse source
This commit is contained in:
famfo 2026-04-03 23:24:39 +02:00
parent 113315248d
commit 8424acd0e1
No known key found for this signature in database
2 changed files with 17 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/server_server/newsfragments/2326.clarification
View file

@ -1 +1 @@
Clarify the s2s profile query behaviour and responses. Clarify the behaviour and response format of `GET /_matrix/federation/v1/query/profile`.

28
data/api/server-server/query.yaml
View file

@ -115,12 +115,12 @@ paths:
to the target server (identified by the [server name](/appendices/#server-name) to the target server (identified by the [server name](/appendices/#server-name)
in the user ID). in the user ID).
Responding servers MAY Responding servers MAY:
- allow users to set arbitrary key/value pairs in their profile in addition to the - Allow users to set arbitrary key/value pairs in their profile in addition to the
specified pairs specified pairs.
- deny profile look-up over federation by responding with 403 and an error code of - Deny profile look-up over federation by responding with 403 and an error code of
`M_FORBIDDEN` `M_FORBIDDEN`.
- omit certain key/value pairs in the response - Omit certain key/value pairs in the response.
Requesting servers MAY wish to cache the response to this query to avoid requesting the Requesting servers MAY wish to cache the response to this query to avoid requesting the
information too often. information too often.
@ -149,10 +149,12 @@ paths:
responses: responses:
"200": "200":
description: |- description: |-
The profile for the user. If a `field` is specified in the request, only the The profile for the user. If a `field` is specified in the request, the response
matching field MUST included in the response. If no `field` was specified, MUST only included the specified `field`. If no `field` was specified, the response
the response MUST include the fields of the user's profile that can be made SHOULD include all of the fields of the user's profile, which can be made public.
public, such as the display name and avatar.
If a field in the user's profile can't be made public over the federation, the
responding server MAY choose to exclude it in the response.
If the user does not have a particular field set on their profile, the server If the user does not have a particular field set on their profile, the server
MUST either exclude it from the response body or give it the value `null`. MUST either exclude it from the response body or give it the value `null`.
@ -175,8 +177,10 @@ paths:
example: mxc://example.org/MyC00lAvatar example: mxc://example.org/MyC00lAvatar
m.tz: m.tz:
type: string type: string
description: The name of the user's time zone. The name MUST be registered in description: The name of the user's time zone. The name SHOULD be registered in
the [IANA Time Zone Database](https://www.iana.org/time-zones). the [IANA Time Zone Database](https://www.iana.org/time-zones), requesting
servers MUST tolerate invalid or unknown values.
x-addedInMatrixVersion: "1.16"
additionalProperties: additionalProperties:
description: Additional profile fields. description: Additional profile fields.
examples: examples: