apache/pinot

Add documentation for the forceCommit API

Open

#11.212 aberto em 28 de jul. de 2023

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Java (1.234 forks)batch import
documentationgood first issue

Métricas do repositório

Stars
 (4.937 stars)
Métricas de merge de PR
 (Mesclagem média 5d 14h) (191 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
A issue solicita documentação para os endpoints da API forceCommit. Comece examinando a estrutura de documentação da API existente no repositório, provavelmente no diretório 'docs' ou 'documentation'. Procure como outros endpoints semelhantes são documentados. Os endpoints são /tables/{tableName}/forceCommit e /tables/forceCommitStatus/{jobId}. Pesquise o código fonte desses endpoints para entender o comportamento, casos de falha e mudanças de status. Em seguida, escreva uma descrição clara seguindo o estilo de documentação existente.
Pilha de tecnologia
javarest api
Domain
backendapi
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90