id: api-contract-sheet
name:
  ja: API契約の1枚仕様
  en: API Contract Sheet
purpose:
  ja: エンドポイント・認証・入力・出力・失敗応答を1枚で確認する。
  en: API Contract Sheet with explicit source values and reading conditions.
status: published
still: ./still.png
category: specification
catalogOrder: 650
jobs:
  - explain-structure
useCases:
  - process
layoutKinds:
  - 2-column
tags:
  - api-contract-sheet
  - specification
  - offline
  - responsive
whenToUse:
  - ja: エンドポイント・認証・入力・出力・失敗応答を1枚で確認する。
    en: Use to communicate api contract sheet.
avoidWhen:
  - ja: 同じ条件・単位で比較できないデータには使わない
    en: Do not compare values with incompatible units, populations, or assumptions.
requiredInputs:
  - ja: 仕様表示用。APIへの送信や認証操作は行わない。
    en: Provide the source values, labels and decision conditions described by the schema.
relatedLayouts:
  - integration-contract-catalog
dataSchema:
  title: string — 結論を伝える見出し
  subtitle: string? — 出典・時点・母集団や仮定
  method: string — HTTPメソッド
  path: string — エンドポイントのパス
  auth: string — 認証と必要権限
  request: array (name, type, required, description) — リクエストのフィールド
  response: array (name, type, description) — 成功応答のフィールド
  errors: array (status, meaning) — 失敗応答のコードと意味
sources: []