quickwit-oss / quickwit-oss/quickwit
REST endpoints should all have an query parameter to pretty format json output.
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
As an example, here is what we have currently on the endpoint api/v1/version.
curl http://localhost:7280/api/v1/version
{"build_date":"2023-02-12T16:49:31Z","build_profile":"debug","build_target":"aarch64-apple-darwin","cargo_pkg_version":"0.4.0","commit_date":"2023-02-10T09:27:54Z","commit_hash":"1f4697f459005fc99c26a87c3f8bc3b23cc27760","commit_short_hash":"1f4697f","commit_tags":[],"version":"0.4.0-nightly"}
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 api/v1/version endpoint and trace how REST endpoints serialize JSON responses. Determine the query-parameter name and expected behavior for pretty formatting across all REST endpoints. Done means each endpoint supports the parameter and returns formatted JSON when it is requested.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100