matrix-org / matrix-org/matrix-spec
client/user_directory/ should be client/directory/user/
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
The Client-Server *unstable* 8.1 User Directory added by matrix-org/matrix-spec-proposals#1096 and matrix-org/matrix-spec-proposals#953 with endpoint 8.1.1 POST
`/_matrix/client/r0/user_directory/search`
should be
`/_matrix/client/r0/directory/user/search`
as well as future endpoints under `/_matrix/client/r0/directory/user/`. This is consistent with the existing Client-Server 7.2 endpoints for the room directory:
7.2.1 PUT `/_matrix/client/r0/directory/room/{roomAlias}`
7.2.2 GET `/_matrix/client/r0/directory/room/{roomAlias}`
7.2.3 DELETE `/_matrix/client/r0/directory/room/{roomAlias}`
Contributor guide
Research direction
Search the specification for `/_matrix/client/r0/user_directory/search` and compare that section with the existing `directory/room` endpoints listed in the issue. Update the user-directory path to `/_matrix/client/r0/directory/user/search` and ensure future user-directory endpoints use the same prefix.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100