matrix-org / matrix-org/matrix-spec
/profile body parameters: required not omittable
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
This is a simple clarification hopefully not needing too much time. The current API definition says that `displayname` and `avatar_url` in `/profile/{}/displayname` and `/profile/{}/avatar_url` respectively are not required. However, Synapse complains - and I think rightfully - when I completely omit the parameter (in a wrong way but that's a [separate issue](https://github.com/matrix-org/synapse/issues/8029)). Should Synapse or the spec be fixed?
Contributor guide
Research direction
Compare the API definition for `/profile/{}/displayname` and `/profile/{}/avatar_url` with Synapse's handling of omitted body parameters. Determine whether the specification or Synapse should define these parameters as required, then update the relevant clarification so the endpoint behavior and ownership are consistent.
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
- Mostly clear
- Newbie friendliness
- 35/100