Skip to main content

Merchant API Contract

merchant-api public routes are documented by generated OpenAPI, not by a manual implementation plan.

Source of Truth

  • Runtime source: apps/microservices/merchant-api/
  • Service guide: apps/microservices/merchant-api/AGENTS.md
  • Generated contract: artifacts/openapi/merchant-api.openapi.json
  • Generated SDK checks: tools/openapi-generator/ and scripts/check-sdk-drift.py

Maintenance Rule

When adding or removing a merchant route, update the controller/service source, regenerate OpenAPI and SDK output, then run:

./scripts/test-local.sh contracts

Do not add phase plans, endpoint count tables, or copied DTO inventories here. Those drift from controller annotations and generated clients.