Skip to content

API Conventions

Base pattern

  • GET /core/... for query operations
  • POST /core/... for create/process commands
  • PUT/PATCH for updates when idempotency is required

Response shape

  • JSON payloads
  • HTTP status aligned to operation outcomes
  • Structured validation errors for failed requests

Backward compatibility

  • Additive changes are preferred.
  • Breaking changes require versioned paths or staged migration.