matrix-org / matrix-org/matrix-spec
Issues with documentation for search API
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Under "Response format" for the POST /_matrix/client/r0/search API, the documentation for the returned search_categories says:
Required. Describes which categories to search in and their criteria.
This seems like a copy-paste mistake, as surely the response doesn't describe what should be searched for?
Other issues with the search API:
- The description of "room_events" just below seems to exhibit a similar issue.
- Further down, the documentation for "User Profile" is completely empty.
- Earlier issue matrix-org/matrix-spec#463
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 Response format section for POST /_matrix/client/r0/search in the linked Matrix Client-Server API specification, then inspect the room_events description and the empty User Profile section. Compare the response fields with the request descriptions and review matrix-org/matrix-spec#463; done means all identified search API documentation errors are corrected and the missing profile description is completed.
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
- 45/100