daniele-liprandi/EvoNEST-backbone

Missing API documentation for external endpoints

Aperta

#24 aperta il 26 nov 2025

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (2 fork)auto 404
BackendLowenhancementgood first issue

Metriche repository

Star
 (1 stella)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina i gestori degli endpoint esistenti in src/app/api/samples/ext/ e src/app/api/traits/ext/ per comprendere la loro funzionalità, poi documenta il loro utilizzo, l'autenticazione e il rate limiting in un file README o di documentazione.
Tech stack
javascript
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90