quickwit-oss/quickwit

Add some examples of requests in the REST API reference docs

Open

#4 266 ouverte le 12 déc. 2023

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Rust (553 forks)github user discovery
enhancementgood first issue

Métriques du dépôt

Stars
 (11 300 stars)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Examinez la documentation actuelle de l'API REST pour la recherche, identifiez les exemples manquants (en particulier pour le tri) et ajoutez des échantillons clairs de requête/réponse.
Stack technique
rest api
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85