apache/pinot

Add documentation for the forceCommit API

Open

#11212 opened on Jul 28, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (4,937 stars) (1,234 forks)batch import
documentationgood first issue

Description

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

Contributor guide

Tech stack
javarest api
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.