← Browse

@carlosdanieldev/api-contract-validation

A

API contract validation patterns for ensuring client-side models match backend JSON responses. Tech-stack agnostic.

skillclaude

Install

agr install @carlosdanieldev/api-contract-validation --target claude

Writes 1 file into .claude/skills/, pinned to git-d2ef8b9d.

  • .claude/skills/api-contract-validation/SKILL.md

Document


name: api-contract-validation version: "2.0.0" description: API contract validation patterns for ensuring client-side models match backend JSON responses. Tech-stack agnostic. allowed-tools: Read, Grep, Glob, WebSearch

API Contract Validation

Purpose

Prevent bugs where client-side models don't match backend API responses.

Contract Location

docs/api-contracts/{feature}-{endpoint}.json

Schema Format

{
  "$schema": "api-contract-v1",
  "endpoint": "GET /api/items",
  "description": "What this endpoint does",
  "response": {
    "items": {
      "type": "array",
      "items": {
        "id": { "type": "string", "required": true },
        "name": { "type": "string", "required": true }
      }
    }
  }
}

Validation: required fields = non-nullable, optional = nullable. No ghost fields.

Trustgrade A

  • passBody integrity

    Whether the stored document is plausibly the kind of file the artifact declares, rather than something fetched by mistake.

  • passType matchnot applicable to this artifact type

    Whether the artifact is really the kind of thing its metadata claims it is.

  • passFreshness

    How long since the source repository was last pushed to.

  • passPrompt injection

    Scans the artifact's own text for instructions aimed at your agent rather than at you.

  • passLicense

    Whether the source repository declares an SPDX license permissive enough to redistribute.

How the grade is calculated

Each check contributes 0 points when it passes, 1 when it warns, and 2 when it fails. The total maps to a letter:

  • Aevery check passed
  • Bone warning
  • Ctwo warnings
  • Dprompt injection or body integrity failed, or three warnings
  • Fone of those failed, and something else is wrong

These are automated hygiene checks, not a security audit, and not a dependency or vulnerability scan. A grade of A means nothing was flagged — not that the artifact is safe.

Versions

  • git-d2ef8b9db9832026-07-31