Skip to main content

Request Response Catalog

Request/response contract catalog​

This page focuses on payload structures consumed by clients and returned by APIs.

Minimum content per endpoint​

  • Required fields and data types.
  • Valid request example.
  • Success and common error responses.
  • HTTP status code usage.

Source of truth​

Derive examples from validators, resource transformers, and API tests so contracts stay implementation-accurate.

Integration note​

Mark breaking field changes explicitly and communicate them before deployment.