matrix-org / matrix-org/matrix-spec
Document that the auth on the identity service API is used exclusively for tracking ToS acceptance
Open
Nobody has claimed this yet.
A-Identity-Service
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
The fact that this doesn't appear to be documented anywhere caused some internal confusion during the bug bounty.
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 by locating the Matrix specification entry for the identity service API and its authentication behavior. Document that authentication is used exclusively to track Terms of Service acceptance, and consider the work complete when this purpose is clearly stated where users look for the API's authentication details.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, authentication, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100