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 合併指標
 (平均合併 5天 14小時) (30 天內合併 191 個 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