daniele-liprandi/EvoNEST-backbone

Missing API documentation for external endpoints

Open

#24 opened on Nov 26, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (2 forks)auto 404
BackendLowenhancementgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Review the existing endpoint handlers in src/app/api/samples/ext/ and src/app/api/traits/ext/ to understand their functionality, then document their usage, authentication, and rate limiting in a README or docs file.
Tech stack
javascript
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90