apache/pinot

Add documentation for the forceCommit API

Open

#11,212 创建于 2023年7月28日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Java (1,234 fork)batch import
documentationgood first issue

仓库指标

Star
 (4,937 star)
PR 合并指标
 (平均合并 6天 7小时) (30 天内合并 186 个 PR)

描述

It would be great to add user-facing documentation for:

  • ​/tables​/{tableName}​/forceCommit: Would be useful to know how it works and what happens when it fails
  • /tables/forceCommitStatus/{jobId}: Would be useful to know how status of the jobs changes/how they're cleaned up

贡献者指南

研究方向
该问题要求为 forceCommit API 端点编写文档。首先检查仓库中现有的 API 文档结构，可能在 'docs' 或 'documentation' 目录中。查看其他类似端点是如何记录的。端点为 /tables/{tableName}/forceCommit 和 /tables/forceCommitStatus/{jobId}。研究这些端点的源代码，以了解其行为、失败情况和状态变化。然后按照现有文档风格编写清晰的描述。
技术栈
javarest api
领域
backendapi
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90