API Bug Report Template

API Bug Report Template

APIs have unique debugging requirements compared to UI bugs. An API-specific template captures the technical details needed to reproduce network-level issues.

Essential Fields for API Bugs

name: "API Bug Report"
description: "Report an API endpoint issue"
title: "[API]: "
labels: ["bug", "api"]
body:
  - type: input
    id: endpoint
    attributes:
      label: "Endpoint"
      description: "The full URL or path of the affected endpoint"
      placeholder: "GET /api/v2/users/:id"
    validations:
      required: true
  - type: dropdown
    id: http_method
    attributes:
      label: "HTTP Method"
      options:
        - "GET"
        - "POST"
        - "PUT"
        - "PATCH"
        - "DELETE"
        - "OPTIONS"
        - "HEAD"
    validations:
      required: true
  - type: textarea
    id: request_body
    attributes:
      label: "Request Body / Parameters"
      description: "Include headers, query parameters, and request body (redact any secrets)"
      render: json
    validations:
      required: false
  - type: input
    id: status_code
    attributes:
      label: "Response Status Code"
      placeholder: "500"
    validations:
      required: true
  - type: textarea
    id: response_body
    attributes:
      label: "Response Body"
      description: "The actual response received"
      render: json
    validations:
      required: false

Why render: json?

The render attribute on textarea fields tells GitHub to syntax-highlight the content. Using render: json makes request and response bodies much easier to read in the filed issue.

Security Considerations

Add a markdown section reminding reporters to redact authentication tokens, API keys, and personally identifiable information before submitting. Include a checkbox confirming they have removed sensitive data.

Curl Command Field

Consider adding an optional textarea for a curl command that reproduces the issue. This lets developers copy-paste directly into their terminal for instant reproduction.