PythonBulawayo/ChitChat

Add API Endpoint Documentation

Aberta

#23 aberto em 25 de jan. de 2024

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)TypeScript (24 forks)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (25 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

The API is currently undocumented. Add documentation to make it easy to build against the API. We should consider using a tool like Swagger to document our endpoints.

Guia do colaborador

Direção de pesquisa
Explore o codebase para identificar todos os endpoints da API e escolha uma ferramenta de documentação como o Swagger para documentar cada endpoint com métodos, parâmetros e exemplos de resposta.
Pilha de tecnologia
typescript
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.
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.
75