yugabyte/yugabyte-db

[DocDB] Document list of all API's under api/v1

Open

#13.998 aberto em 13 de set. de 2022

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)C (1.003 forks)batch import
area/docdbgood first issuekind/bugpriority/medium

Métricas do repositório

Stars
 (8.229 stars)
Métricas de merge de PR
 (Mesclagem média 17d 21h) (92 fundiu PRs em 30d)

Description

Jira Link: DB-3497

Description

We don't have a list of all API's under api/v1 documented for other engineering teams to consume. Please document a list of all the APIs under api/v1 endpoint.

Guia do colaborador

Direção de pesquisa
Primeiro, examine o código fonte para identificar todos os manipuladores registrados para o caminho /api/v1/. Procure por definições de rota em arquivos como `src/yb/server/webserver.cc` ou similares. Compile uma lista de caminhos de endpoint e métodos HTTP. Por fim, documente a lista no arquivo apropriado, provavelmente no diretório `docs/` ou em um README. Não há PRs ou comentários existentes.
Pilha de tecnologia
None
Domain
apidocumentation
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.
1
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Gitbasic knowledge of REST APIs
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85