apache/pinot

Add documentation for the forceCommit API

Open

#11,212 opened on 2023年7月28日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Java (4,937 stars) (1,234 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.