quickwit-oss / quickwit-oss/quickwit
Revisit the protobuf API for snippet requests
Open
Nobody has claimed this yet.
bug
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
Right now the API is very non explanatory.
To get a snippet, one have to fill search_request and doc_mapper.
Maybe we could have an optional SnippetRequest object containing these two?
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 by locating the protobuf API definition for snippet requests and reading how search_request and doc_mapper are currently used. The issue suggests an optional SnippetRequest containing those fields; done means the API is more explanatory while preserving the ability to request a snippet.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100