quickwit-oss / quickwit-oss/quickwit
Add some examples of requests in the REST API reference docs
Open
Beginner friendly
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
https://quickwit.io/docs/reference/rest-api#search-api
Use case: I want to sort by a field and I can't find how to do it.
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 at the linked REST API reference, specifically the Search API section, and review how request examples are currently presented. Add examples that show sorting by a field, then verify the documentation clearly demonstrates the request syntax and the intended result.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation, search
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100