💡
AB-148

Request/response examples

📖 Documentation Pillar: Understandability Quick fix Est. cost: $0

What it means

OpenAPI operations include example requests and responses.

Why it matters

Examples let agents construct valid requests without trial-and-error.

What's wrong

responses: { '200': { description: 'OK' } }

What's right

responses: { '200': { content: { 'application/json': { example: { id: 'ch_123', amount: 5000 } } } } }

Check this rule on your site

Enter your URL to check just this one rule (AB-001).

Related rules in Documentation