matrix-org / matrix-org/matrix-spec
`GET /_matrix/client/v3/profile/...` states it do not require auth, but implementations can require auth
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/#get_matrixclientv3profileuserid
**Issue**
The spec says mentions that authentication is not required for the endpoint, but Synapse for example may gate the endpoint behind auth.
This really makes a lot of sense. You may not want people to enumerate your user ids, nor do driveby requests for your profile data if you do not share a room. I think the spec should be clear that authentication may be required,
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 GET /_matrix/client/v3/profile/{userId} section at the linked Client-Server API specification page and review how it describes authentication. Clarify that implementations may require authentication for this endpoint, while preserving the intended behavior; done means the normative text accurately reflects that option.
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
- 35/100