Skip to main content

Use the service contract


Lerian products do not share one universal error envelope or error-code format. For each operation, use the response schema and error reference implemented by that service as the source of truth. Before handling an error programmatically, verify:
  • The response media type and schema.
  • Whether the service exposes a stable error code.
  • The fields that are present for that operation and status code.
  • The documented retry or remediation guidance.

Field validation


Some services return field-level validation details and others use a different error shape. Document those details only when they are present in the operation’s implemented contract.

Error codes


Error-code prefixes, numeric formats, and meanings vary by product. Do not infer an error’s meaning from a code used by another service. Consult the product-specific error reference before acting on an error code.

Authoring API reference


Keep request, response, and error schemas in the service specification. Render operation pages from that specification rather than copying an error model into hand-written endpoint documentation.