Content

Latest SDK example verification run

Every example on the SDK reference is executed against this API on a schedule and after each SDK release: the published package, a fresh project, the snippet exactly as printed. This returns the most recent run for each language, with the outcome of each example. Write examples are never run against production, since they would create a real ticket, webhook endpoint or seller offer, and are reported as skipped with that reason, so the counts never imply coverage the run does not have.

No API key required.

get/v1/sdk/verification

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/sdk/verification
  • Auth: one of:
    • none
    • API key in header X-API-Key
    • HTTP bearer

Response

Latest SDK example verification run

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": {
    "runs": [
      {
        "surface": "api",
        "language": "typescript",
        "checkKind": "executed",
        "sdkVersion": "0.2.3",
        "apiHost": "https://api.gunspec.io",
        "ranAt": "2026-09-13T03:15:00.000Z",
        "commitSha": "9f1c2ab",
        "runUrl": "https://github.com/buun-group/gunspec/actions/runs/123456",
        "passed": 118,
        "skipped": 13,
        "unsupported": 11,
        "examples": [
          {
            "exampleId": "sdk-firearms-list",
            "resource": "firearms",
            "method": "list",
            "endpoint": "GET /v1/firearms",
            "status": "passed",
            "durationMs": 412,
            "hasSample": true,
            "sample": {
              "id": "glock-g17",
              "name": "Glock 17"
            }
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.