quickwit-oss/quickwit

Add some examples of requests in the REST API reference docs

Open

#4,266 opened on Dec 12, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Rust (580 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (11,532 stars)
PR merge metrics
 (Avg merge 5d 18h) (41 merged PRs in 30d)

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

Research direction
Examine the current REST API documentation for search, identify missing examples (particularly for sorting), and add clear request/response samples.
Tech stack
rest api
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85