Skip to main content

Internal API Reference

Status: 🆕 To be written
Audience: Developers
Scope: All internal HTTP endpoints across the three backend services

TODO​

This document is a planned stub. It will cover:

  • User Management Service (port 3001) — all endpoints, request/response schemas, auth policy per endpoint
  • Data Service (port 3002) — all endpoints, request/response schemas, auth policy per endpoint (including Provider ingest)
  • Business Logic Service (port 3003) — all endpoints, request/response schemas, auth policy per endpoint (including Admin Log API)
  • Health and readiness probe formats (/health, /ready)
  • Common error response format (RFC 9457 Problem Details)
  • Rate limiting behaviour (headers, limits, scope)

See 00_INDEX.md for implementation order.