matrix-org / matrix-org/matrix-spec
Spec doesn't consider error cases for `/_matrix/identity/v2/account/register`
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Link to problem area**: https://matrix.org/docs/spec/identity_service/r0.3.0#post-matrix-identity-v2-account-register
Cropped up in
(Context: matrix-org/sydent#452, matrix-org/sydent#456).
**Issue**
To facilitate this request, the identity server must contact a remote homeserver and present an access token. This can fail in a number of ways (not exhaustive):
- We might be unable to resolve the homeserver's hostname.
- Our connection to the homeserver may fail or timeout.
- The homeserver may deny our request, if we were given an expired or invalid access token.
- The homeserver may respond with invalid JSON, or not include the information we require.
The spec does not consider any of these and only describes a 200 OK happy path.
I would like to return a meaningful http status code in these cases, but am not sure what The Done Thing is.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the linked Matrix identity-service specification section for POST /_matrix/identity/v2/account/register, then review the related Sydent issues matrix-org/sydent#452 and #456. Document how hostname, connection, authorization, and response-content failures should be represented, with the specification's completed error behavior agreed and recorded.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100