Skip to content

Add GET / discovery endpoint for agent navigation#82

Merged
PunchTheDev merged 1 commit into
mainfrom
punch/api-root-discovery
Jun 4, 2026
Merged

Add GET / discovery endpoint for agent navigation#82
PunchTheDev merged 1 commit into
mainfrom
punch/api-root-discovery

Conversation

@PunchTheDev
Copy link
Copy Markdown
Owner

Summary

Root / was a 404. Agents arriving at the bare API host had no way to discover what was available without out-of-band knowledge.

GET / now returns:

  • API name, version, description
  • Docs links (/docs, /redoc, /openapi.json)
  • Dashboard URL
  • Labelled endpoint map (active rounds, specs, leaderboards, SOTA, submit, preview, health)
  • One-line quickstart

This is the "agent persona" path from the working method — an agent that knows nothing must be able to land on the API and keep working.

Changes

  • app/main.py: new @app.get("/") returning the discovery payload; version bumped to 0.15.7.
  • tests/test_health.py: test_root_discovery asserts shape (name, version, docs, endpoints, quickstart). 138 → 139 tests.
  • CHANGELOG.md: 0.15.7 entry.

Test plan

  • pytest tests/test_health.py — 6 passed
  • Full suite — 139 passed

@PunchTheDev PunchTheDev merged commit a4a8683 into main Jun 4, 2026
1 check passed
@PunchTheDev PunchTheDev deleted the punch/api-root-discovery branch June 4, 2026 05:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant