yugabyte/yugabyte-db

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

Open

#13 998 ouverte le 13 sept. 2022

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)C (1 003 forks)batch import
area/docdbgood first issuekind/bugpriority/medium

Métriques du dépôt

Stars
 (8 229 stars)
Métriques de merge PR
 (Merge moyen 17j 21h) (92 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Tout d'abord, examinez le code source pour identifier tous les gestionnaires enregistrés pour le chemin /api/v1/. Recherchez les définitions de route dans des fichiers tels que `src/yb/server/webserver.cc` ou similaires. Compilez une liste des chemins d'endpoint et des méthodes HTTP. Enfin, documentez la liste dans le fichier approprié, probablement dans le répertoire `docs/` ou dans un README. Aucune PR ou commentaire existant n'est présent.
Stack technique
Aucun
Domaine
apidocumentation
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.
1-3 heures
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
Gitbasic knowledge of REST APIs
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85