archive
/
matrix-spec
mirror of https://github.com/matrix-org/matrix-spec
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
main
release/v1.12
dbkr/msc4178
release/v1.11
tulir/msc4142
release/v1.10
travis/msc2702-msc2701
rav/ref_objects_in_params
dkasak/foldable-sidebar
travis/knock-join
release/v1.9
release/v1.8
anoa/update_docsy
anoa/nix_flake
dbkr/3077-multi-stream-voip
release/v1.7
dbkr/2746-reliable-voip
rav/links_for_object_defs
release/v1.6
release/v1.5
release/v1.4
anoa/invite_knock_room_state
release/v1.3
push_gateway/r0.1.0
r0.0.0
0.2.0
application_service/r0.1.0
application_service/r0.1.1
application_service/r0.1.2
client-server/0.3.0
client-server/r0.1.0
client-server/r0.2.0
client-server/r0.3.0
client_server/r0.4.0
client_server/r0.5.0
client_server/r0.6.0
client_server/r0.6.1
identity_service/r0.1.0
identity_service/r0.2.0
identity_service/r0.2.1
identity_service/r0.3.0
push_gateway/r0.1.1
r0.0.1
server_server/r0.1.0
server_server/r0.1.1
server_server/r0.1.2
server_server/r0.1.3
server_server/r0.1.4
v1.1
v1.10
v1.11
v1.12
v1.2
v1.3
v1.4
v1.5
v1.6
v1.7
v1.8
v1.9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e32d9a9af3'
${ noResults }
matrix-spec/proposals/2663-errors-nonexistent-pus...

1.5 KiB
Raw Blame History

MSC2663: Errors for dealing with non-existent push rules

This MSC proposes that homeservers respond with a HTTP 404 ('Not Found') status code and an errcode of M_NOT_FOUND when a client attempts to read or write the enabled status or actions of a non-existent push rule.

Background

The current revision of the Client-Server specification does not make clear what a homeserver implementation is meant to do when getting or setting the enabled or actions properties of a supposed push rule that does not exist.

Motivation

This change is considered minor and the proposed error code is deemed unsurprising as it matches the remainder of the specification.

Proposal

The following endpoints of the Client-Server specification are affected:

  • GET /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}
  • DELETE /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}
  • PUT /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}
  • GET /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/enabled
  • PUT /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/enabled
  • GET /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/actions
  • PUT /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/actions

The affected endpoints will have the following response status code added:

Status code 404:

The push rule does not exist.

Example

{
  "errcode": "M_NOT_FOUND"
}

This error response is to be returned when the push rule represented by {scope}/{kind}/{ruleId} does not exist.