yugabyte/yugabyte-db

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

Open

#13.998 geöffnet am 13. Sept. 2022

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C (1.003 Forks)batch import
area/docdbgood first issuekind/bugpriority/medium

Repository-Metriken

Stars
 (8.229 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 17T 21h) (92 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie zunächst den Quellcode, um alle für den Pfad /api/v1/ registrierten Handler zu identifizieren. Suchen Sie nach Routendefinitionen in Dateien wie `src/yb/server/webserver.cc` oder ähnlichen. Erstellen Sie eine Liste der Endpunktpfade und HTTP Methoden. Dokumentieren Sie abschließend die Liste in der entsprechenden Datei, wahrscheinlich im Verzeichnis `docs/` oder in einer README. Es gibt keine bestehenden PRs oder Kommentare.
Tech Stack
Keine
Domain
apidocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Gitbasic knowledge of REST APIs
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85