yugabyte/yugabyte-db

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

Open

#13,998 opened on Sep 13, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C (1,003 forks)batch import
area/docdbgood first issuekind/bugpriority/medium

Repository metrics

Stars
 (8,229 stars)
PR merge metrics
 (Avg merge 17d 21h) (92 merged PRs in 30d)

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.

Contributor guide

Research direction
Find the API route definitions and list all endpoints under /api/v1.
Tech stack
None
Domain
apidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitbasic knowledge of REST APIs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85