Bug Report Template for API Products
API bugs affect downstream integrations, making them high-impact by default. Reports must include exact request/response data for reproduction.
This template captures the technical context needed to reproduce and assess API bug impact.
Template sections
4 sections covering the complete bug report workflow.
Request and Response
Include the exact cURL command that reproduces the bug with the full response. Redact sensitive values but preserve structure.
SDK and Client Context
Document the SDK language, version, and configuration. Many API bugs are SDK-specific rather than API-specific.
Breaking Change Assessment
Determine if this bug represents a deviation from the documented API contract. If clients depend on current behavior, fixing it is a breaking change.
Customer Impact
Estimate affected API consumers: check logs for the endpoint, determine failure rate, and identify impacted integrations.
Copy-paste template
## API Bug Report ### Summary: [Bug description] ### Reproduction: [cURL command] ### Expected Response: [Schema] ### Actual Response: [Schema] ### SDK: [Language vX.Y.Z] ### Breaking Change: [Yes/No] ### Affected Customers: [Count]
Frequently asked questions
Generate instead of filling in templates
Connect your tools, and Vantage generates the content using real product data. Free to start.
Free to start. No credit card required.