REST /api/v1/lint-runs 5 endpoints
GET /api/v1/lint-runs/api/v1/lint-runs

List all CI lint run results

Public

Response Example

{
  "data": [
    {
      "id": "lr-001",
      "manifest_path": "tokens/accessibility-manifest.json",
      "status": "passed",
      "violation_count": 0,
      "exit_code": 0,
      "branch": "main",
      "triggered_at": "2026-03-26T08:00:00Z"
    },
    {
      "id": "lr-002",
      "manifest_path": "tokens/accessibility-manifest.json",
      "status": "failed",
      "violation_count": 4,
      "exit_code": 1,
      "branch": "feature/new-tokens",
      "triggered_at": "2026-03-26T09:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 14
  }
}
GET /api/v1/lint-runs/api/v1/lint-runs/:id

Get a specific lint run with full violation detail

Public

Response Example

{
  "id": "lr-002",
  "manifest_path": "tokens/accessibility-manifest.json",
  "status": "failed",
  "violation_count": 4,
  "exit_code": 1,
  "branch": "feature/new-tokens",
  "violations": [
    {
      "rule": "min-contrast-normal-text",
      "token_key": "color.text.disabled",
      "actual": 2.1,
      "required": 4.5,
      "severity": "error"
    }
  ],
  "triggered_at": "2026-03-26T09:00:00Z",
  "completed_at": "2026-03-26T09:00:08Z"
}
POST /api/v1/lint-runs/api/v1/lint-runs

Trigger a new CI lint validation run

Public

Request Example

{
  "manifest_path": "tokens/accessibility-manifest.json",
  "branch": "feature/redesign",
  "fail_on_warning": false
}

Response Example

{
  "id": "lr-015",
  "manifest_path": "tokens/accessibility-manifest.json",
  "status": "running",
  "branch": "feature/redesign",
  "fail_on_warning": false,
  "triggered_at": "2026-03-26T10:00:00Z"
}
PUT /api/v1/lint-runs/api/v1/lint-runs/:id

Update metadata on a lint run (e.g. add CI build reference)

Public

Request Example

{
  "ci_build_id": "build-9921",
  "ci_pipeline": "github-actions"
}

Response Example

{
  "id": "lr-015",
  "manifest_path": "tokens/accessibility-manifest.json",
  "status": "passed",
  "violation_count": 0,
  "exit_code": 0,
  "ci_build_id": "build-9921",
  "ci_pipeline": "github-actions",
  "branch": "feature/redesign",
  "triggered_at": "2026-03-26T10:00:00Z",
  "completed_at": "2026-03-26T10:00:09Z"
}
DELETE /api/v1/lint-runs/api/v1/lint-runs/:id

Delete a lint run record

Public

Response Example

{
  "deleted": true,
  "id": "lr-015"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}