name: api-contract-flow description: 発火: API変更、エンドポイント更新、OpenAPI、Orval、generated hooks。スキーマ更新から生成物同期までを一貫実行する。
API 契約フロー
発火条件
- 依頼に
API変更,endpoint,schema,openapi,orval,generated hooksが含まれる packages/validation/src/openapi/*またはapps/backend/src/schemas/*に変更が入る
入力前提
- 変更対象エンドポイントと想定レスポンス形が明確である
- 互換性要件(破壊的変更可否)が明確である
実行ステップ
- スキーマ更新
packages/validation/src/openapi/*.tsとapps/backend/src/schemas/*.tsを更新する
- OpenAPI 再出力
bun run --cwd apps/backend openapi:exportを実行する
- Orval 再生成
bun run --cwd packages/api-types generateまたはbun run generate:api-typesを実行する
- フロント反映
apps/frontend/src/features/status/api/generated配下の hooks/型を利用する- 手書き API hooks/型を追加しない
- 差分確認
- 生成物差分を同一コミットに含める
検証コマンド
bun run --cwd apps/backend openapi:exportbun run generate:api-typesbun run check:generated:cleanbun run lint
出力契約
- 変更した schema/OpenAPI/generated ファイルを列挙する
- 破壊的変更の有無を明記する
- 未実行検証があれば理由を明記する