yugabyte/yugabyte-db

[DocDB] Document list of all API's under api/v1

Open

#13.998 aperta il 13 set 2022

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C (1003 fork)batch import
area/docdbgood first issuekind/bugpriority/medium

Metriche repository

Star
 (8229 star)
Metriche merge PR
 (Merge medio 17g 21h) (92 PR mergiate in 30 g)

Descrizione

Jira Link: DB-3497

Description

We don't have a list of all API's under api/v1 documented for other engineering teams to consume. Please document a list of all the APIs under api/v1 endpoint.

Guida contributor

Direzione di ricerca
Innanzitutto, esamina il codice sorgente per identificare tutti i gestori registrati per il percorso /api/v1/. Cerca le definizioni delle route in file come `src/yb/server/webserver.cc` o simili. Compila un elenco dei percorsi degli endpoint e dei metodi HTTP. Infine, documenta l'elenco nel file appropriato, probabilmente nella directory `docs/` o in un README. Non sono presenti PR o commenti esistenti.
Tech stack
Nessuno
Dominio
apidocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Gitbasic knowledge of REST APIs
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85