Skip to content
rd-skills
All skills

api-contract-design

FoundationJIT only

analysis-agent/task-agent/review-agent: use when endpoints, payloads, errors, auth, pagination, idempotency, or compatibility need a contract; skip when APIs are unchanged.

Group
Data & API contracts
Supported roles
MainAnalysisTaskReview
Source
SKILL.md

Use when

Trigger signals that make this skill the right owner

  • design API endpoints resources methods payloads pagination and compatibility

Do not use when

Anti-triggers — as binding as the triggers above

  • no task-local api contract design decision is required

Required inputs

What must be supplied before this skill can decide anything

  • current task contract
  • selected primary Professional Skill
  • task-local trigger evidence

Output contract

What this skill owes the next role

  • API contract decision with consumer and resource semantics, trusted context, request and response meaning, errors, repeat delivery, pagination or completion, compatibility evidence, and proof limits

Escalation signals

When this skill must hand the decision back

  • Contract ambiguity breaks clients and makes backward compatibility difficult

Loaded by

This skill never owns a task. These professionals may pull it in as Layer 3.

Targeted references

Each reference carries its own load condition. None of them enter context by default.

ReferenceLoad whenDo not load whenRequired by
api-style-and-semantics.mdtargetedProtocol semantics, versioning, or idempotency choices remain contested.An additive bounded contract change preserves established semantics.AnalysisTaskReview
checklist.mddecision-checklistThe contract changes pagination, errors, authorization, or replay behavior.Only documentation wording changes; wire behavior remains identical.AnalysisTaskReview
evidence-patterns.mdevidence-patternConsumer compatibility depends on fresh specs, clients, or contract tests.No consumer-visible contract claim requires validation.AnalysisTaskReview