Files
magnus919_agent-skills/api-design-and-evolution/templates/api-design-brief.md
T

833 B

API Design Brief

Consumer Jobs And Context

  • Consumers and jobs:
  • Current workflow and failure consequences:
  • Supported interface style and why:
  • Rejected styles and trade-offs:

Domain And Authority

  • Domain terms, invariants, and authoritative schema/owner:
  • Actors, subject/action/object/tenant authorization boundary:
  • Data classification and security handoff needed:
  • Assumptions, open questions, accountable owner:

Interaction And Failure Model

  • Read, command, event, callback, or stream semantics:
  • Consistency, delivery, ordering, duplicate, gap, and partial-failure expectations:
  • Resource/cost limits and observability needs:
  • Consumer/tooling constraints:

Decision

  • Contract format and published artifact:
  • Compatibility/evolution posture:
  • Follow-up artifacts and verification evidence: