apache/pinot

Add documentation for the forceCommit API

Open

#11.212 aperta il 28 lug 2023

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Java (1234 fork)batch import
documentationgood first issue

Metriche repository

Star
 (4937 star)
Metriche merge PR
 (Merge medio 5g 14h) (191 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Il problema richiede la documentazione per gli endpoint API forceCommit. Inizia esaminando la struttura della documentazione API esistente nel repository, probabilmente nella directory 'docs' o 'documentation'. Cerca come sono documentati altri endpoint simili. Gli endpoint sono /tables/{tableName}/forceCommit e /tables/forceCommitStatus/{jobId}. Ricerca il codice sorgente di questi endpoint per comprenderne il comportamento, i casi di errore e i cambiamenti di stato. Quindi scrivi una descrizione chiara seguendo lo stile di documentazione esistente.
Tech stack
javarest api
Dominio
backendapi
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90