Skip to content

Documentation references incorrect API endpoint (/api/v1/ vs /api/v0/) #2516

@EclipseAditya

Description

@EclipseAditya

The bug

The contributing documentation references incorrect API endpoints (/api/v1/) for local development verification, but the backend only serves /api/v0/. Additionally, the production nginx configuration routes to /api/v1/ while both staging and the backend use /api/v0/, creating environment inconsistency.

To Reproduce

Steps to reproduce the behavior:

  1. Follow the contributing guide setup instructions in CONTRIBUTING.md or docs/contributing.md
  2. Run make run to start local development environment
  3. Navigate to http://localhost:8000/api/v1/ as instructed in the documentation
  4. See 404 Not Found error

Expected behavior

  • Documentation should reference the correct API endpoint (/api/v0/) that matches the actual backend implementation
  • All environments (local, staging, production) should have consistent API routing

Are you going to work on fixing this?

  • Yes (Ready to send Pr)
  • No

Additional context

Root Cause: After refactoring in commit ad007b7 (Sept 10, 2025) "Refactor API to a separate app, add v0 (#2245)"

What was updated:

What was missed:

Current State:

  • Backend serves: /api/v0/
  • Local: Direct access to /api/v0/
  • Staging: Routes /api/v0/
  • Production: Routes /api/v1/
  • Documentation: References /api/v1/

Affected Files:

Screenshots
Testing locally shows:

  • http://localhost:8000/api/v0/ → Returns: {"message": "Welcome to the OWASP Nest API v0", "docs_url": "http://localhost:8000/api/v0/docs"}
Image
  • http://localhost:8000/api/v1/ → Returns: 404 Not Found
Image

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions