Skip to content

Commit

Permalink
Clarify where errors apply
Browse files Browse the repository at this point in the history
  • Loading branch information
tcpipuk authored Jan 13, 2025
1 parent a11286a commit 2a86235
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion proposals/4133-extended-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,8 @@ demonstrates the process of defining new fields in the `m.*` namespace.
}
```

- **`M_MISSING_PARAM`**: Required parameter is missing, e.g. if a client attempts to set a profile field, but neglects to include that named field in the request body.
- **`M_MISSING_PARAM`**: Required parameter is missing, e.g. if a client attempts to set a profile
field, but neglects to include that named field in the request body.

```json
{
Expand Down Expand Up @@ -249,6 +250,23 @@ A server may return this error in several scenarios:
}
```

### Applicability of Error Codes

Unless explicitly stated otherwise, all error codes described in this
section apply to all Client-Server and Server-Server endpoints introduced
by this MSC. For example:

1. `M_NOT_FOUND` applies to any attempt to retrieve a non-existent profile
field.
2. `M_PROFILE_TOO_LARGE` applies to any attempt to create or update profile
data exceeding the allowed size.

The Server-Server endpoints introduced in this MSC adhere to the existing
error structure for federation, as the federation access remains read-only
in this proposal. This means no new error codes or status code combinations
are introduced for Server-Server endpoints beyond what is already
documented in the specification.

## Propagation of Profile Fields

The existing fields, `avatar_url` and `displayname`, will continue to trigger state events in each
Expand Down

0 comments on commit 2a86235

Please sign in to comment.