apache/pinot

Add documentation for the forceCommit API

Closed

#11,212 opened on Jul 28, 2023

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Java (1,234 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (4,937 stars)
PR merge metrics
 (Avg merge 6d 7h) (186 merged PRs in 30d)

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

Research direction
Examine the existing API documentation structure in the Pinot codebase under docs/ or similar, then create a new page or update the existing API reference for the forceCommit endpoint and its status check endpoint. Include details on request/response formats, failure scenarios, and job cleanup.
Tech stack
javarest api
Domain
backendapi
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90