apache/pinot

Add documentation for the forceCommit API

Fermée

#11 212 ouverte le 28 juil. 2023

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Java (1 234 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (4 937 étoiles)
Métriques de merge PR
 (Merge moyen 6j 7h) (186 PRs mergées en 30 j)

Description

It would be great to add user-facing documentation for:

  • ​/tables​/{tableName}​/forceCommit: Would be useful to know how it works and what happens when it fails
  • /tables/forceCommitStatus/{jobId}: Would be useful to know how status of the jobs changes/how they're cleaned up

Guide contributeur

Direction de recherche
Le problème demande une documentation pour les points de terminaison de l'API forceCommit. Commencez par examiner la structure de documentation API existante dans le dépôt, probablement dans le répertoire 'docs' ou 'documentation'. Recherchez comment d'autres points de terminaison similaires sont documentés. Les points de terminaison sont /tables/{tableName}/forceCommit et /tables/forceCommitStatus/{jobId}. Recherchez le code source de ces points de terminaison pour comprendre le comportement, les cas d'échec et les changements d'état. Ensuite, rédigez une description claire en suivant le style de documentation existant.
Stack technique
javarest api
Domaine
backendapi
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90