daniele-liprandi/EvoNEST-backbone

Missing API documentation for external endpoints

Aberta

#24 aberto em 26 de nov. de 2025

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)JavaScript (2 forks)auto 404
BackendLowenhancementgood first issue

Métricas do repositório

Stars
 (1 estrela)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Description

External API endpoints (/api/samples/ext, /api/traits/ext) are excluded from authentication but lack clear documentation about their intended use and security model.

Files affected

  • src/app/api/samples/ext/
  • src/app/api/traits/ext/

Recommended fix

  1. Document external API usage in README or dedicated docs
  2. Consider API key authentication for external endpoints
  3. Add rate limiting specifically for external endpoints

Guia do colaborador

Direção de pesquisa
Revise os manipuladores de endpoint existentes em src/app/api/samples/ext/ e src/app/api/traits/ext/ para entender sua funcionalidade, depois documente seu uso, autenticação e limitação de taxa em um arquivo README ou de documentação.
Pilha de tecnologia
javascript
Domain
backend
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.
Menos de 1 hora
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
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90