docs-matrix-spec/data/api/client-server
Dan Callahan 48d8f7202d
Add HTTP 403 to possible profile responses (#3530)
* Add HTTP 403 to possible profile responses

Some servers may not allow profile lookup over federation, and thus
respond to GET /_matrix/client/v3/profile/{userId} with an HTTP 403.

For example, Synapse can be configured to behave in this way by setting:

    allow_profile_lookup_over_federation=false

Thus, this behavior already exists in the wild, and may cause issues for
clients such as https://github.com/vector-im/element-web/issues/17269.

Synapse could alter its behavior and return an HTTP 404 in these cases,
but amending the Spec seems preferable to align with extant behavior.
Further, allowing HTTP 403 gives clients more specific information as to
why a request has failed, enabling more precise error handling.

Signed-off-by: Dan Callahan <danc@element.io>

* Update changelogs/client_server/newsfragments/3530.clarification

Co-authored-by: Travis Ralston <travpc@gmail.com>

* Annotate misc data about error

Co-authored-by: Travis Ralston <travpc@gmail.com>
Co-authored-by: Travis Ralston <travisr@matrix.org>
2021-12-29 11:30:32 -07:00
..
definitions Definition of "Standard Identifier Format" (#3171) 2021-12-15 11:38:29 +00:00
account-data.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
admin.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
administrative_contact.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
appservice_room_directory.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
banning.yaml Start annotating which version of the spec added a thing (#3425) 2021-10-14 13:23:04 -06:00
capabilities.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
content-repo.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
create_room.yaml Add GitHub Action to check spelling (#3591) 2021-12-28 09:17:49 -07:00
cross_signing.yaml Start annotating which version of the spec added a thing (#3425) 2021-10-14 13:23:04 -06:00
device_management.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
directory.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
event_context.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
filter.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
inviting.yaml Start annotating which version of the spec added a thing (#3425) 2021-10-14 13:23:04 -06:00
joining.yaml Start annotating which version of the spec added a thing (#3425) 2021-10-14 13:23:04 -06:00
key_backup.yaml OpenAPI: Add missing required flag in getRoomKeys (#3509) 2021-11-22 13:23:24 -05:00
keys.yaml Start annotating which version of the spec added a thing (#3425) 2021-10-14 13:23:04 -06:00
kicking.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
knocking.yaml Start annotating which version of the spec added a thing (#3425) 2021-10-14 13:23:04 -06:00
leaving.yaml Start annotating which version of the spec added a thing (#3425) 2021-10-14 13:23:04 -06:00
list_joined_rooms.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
list_public_rooms.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
login.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
logout.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
message_pagination.yaml typos: Corrected typos in message_pagination.yaml (#3495) 2021-11-15 15:29:07 -05:00
notifications.yaml Remove definition of Event for /notifications (#3525) 2021-12-02 17:23:09 +00:00
old_sync.yaml Add GitHub Action to check spelling (#3591) 2021-12-28 09:17:49 -07:00
openid.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
peeking_events.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
presence.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
profile.yaml Add HTTP 403 to possible profile responses (#3530) 2021-12-29 11:30:32 -07:00
pusher.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
pushrules.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
read_markers.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
receipts.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
redaction.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
registration.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
report_content.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
room_initial_sync.yaml Add GitHub Action to check spelling (#3591) 2021-12-28 09:17:49 -07:00
room_send.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
room_state.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
room_upgrades.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
rooms.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
search.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
sso_login_redirect.yaml Start annotating which version of the spec added a thing (#3425) 2021-10-14 13:23:04 -06:00
sync.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
tags.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
third_party_lookup.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
third_party_membership.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
to_device.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
typing.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
users.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
versions.yaml Describe new global specification versioning (#3420) 2021-10-12 11:06:51 -06:00
voip.yaml Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) (#3421) 2021-10-12 11:07:01 -06:00
wellknown.yaml Change RST code formatting markup to Markdown 2021-08-27 19:16:42 +01:00
whoami.yaml Start annotating which version of the spec added a thing (#3425) 2021-10-14 13:23:04 -06:00