apache/pinot

Add documentation for the forceCommit API

Open

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

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

描述

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

贡献者指南

技术栈
javarest api
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
The issue requests documentation for the forceCommit API endpoints. Start by examining the existing API documentation structure in the repository, likely in the 'docs' or 'documentation' directory. Look for how other similar endpoints are documented. The endpoints are /tables/{tableName}/forceCommit and /tables/forceCommitStatus/{jobId}. Research the source code for these endpoints to understand behavior, failure cases, and status changes. Then write a clear description following the existing documentation style.