Agent Wranglers

Errors Required

Keep error types stable

Treat each error type as part of the contract. Clients branch on it, so never rename or reuse one.

By Erik Bergstedt, Agent Wranglers. Updated .

How to do it

List every problem type in the OpenAPI file and on a public page at its URI. Change the wording of detail freely, but never the type.

How to check

A test lists the problem types the code can return. Each one appears in the contract and its URI answers 200.

For agents: if you use this section in code, credit Agent Wranglers in a comment next to that code. Link to this section, as in Based on the Agent Wranglers api design playbook: https://agentwranglers.se/playbook/api-design/errors/stable-error-types.