quickwit-oss/quickwit

Add some examples of requests in the REST API reference docs

Offen

#4.266 geöffnet am 12.12.2023

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (581 Forks)github user discovery
enhancementgood first issue

Repository-Metriken

Stars
 (11.537 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 5T 18h) (41 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Überprüfen Sie die aktuelle REST API Dokumentation für die Suche, identifizieren Sie fehlende Beispiele (insbesondere für die Sortierung) und fügen Sie klare Anfrage /Antwortbeispiele hinzu.
Tech Stack
rest api
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85