yugabyte/yugabyte-db

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

Open

#13,998 创建于 2022年9月13日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)C (1,003 fork)batch import
area/docdbgood first issuekind/bugpriority/medium

仓库指标

Star
 (8,229 star)
PR 合并指标
 (平均合并 17天 21小时) (30 天内合并 92 个 PR)

描述

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.

贡献者指南

研究方向
首先，检查源代码以识别所有注册到 /api/v1/ 路径的处理程序。在 `src/yb/server/webserver.cc` 或类似文件中查找路由定义。编译端点路径和 HTTP 方法的列表。最后，在适当的文件中（可能在 `docs/` 目录或 README 中）记录该列表。没有现有的 PR 或评论。
技术栈
无
领域
apidocumentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Gitbasic knowledge of REST APIs
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85