matrix-org / matrix-org/matrix-spec
`/register` takes undocumented `type` parameter
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://spec.matrix.org/v1.16/client-server-api/#post_matrixclientv3register
Issue
The Application Service API mentions calling /register with a type parameter, which appears to disable user-interactive authentication.
However, the documentation of /register gives no hint of this parameter existing, nor that UIAA can be skipped in this way. This is somewhat confusing.
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
Start with the linked Client-Server API documentation for POST /register, then compare it with the linked Application Service API section describing the type parameter. Document the parameter and explain how it affects UIAA, with the /register documentation clearly covering this behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100