Skip to content

api+docs(spec): OpenAPI レスポンスコード列挙順序の統一ルール策定 (PR #179 follow-up) #182

Description

@win2cot

背景

PR #179 のレビューで、api/openapi.yaml の各エンドポイントでレスポンスコード列挙順序が不統一であることが指摘された:

エンドポイント 現状の順序
GET /api/tasks/{id} 200404401403
PUT /api/tasks/{id} 200403404401
DELETE /api/tasks/{id} 204403404401
PATCH /api/tasks/{id}/visibility 200400403404401
POST /api/tasks/{id}/stakeholders 201400401403404409

PR #179 が触れた箇所も含む既存問題で、本 PR の範囲外として別 Issue 化された。

やること

  1. 統一ルールを策定
    • 推奨候補: 2xx(成功) → 4xx(クライアントエラー昇順: 400 → 401 → 403 → 404 → 409 → 422)→ 5xx(サーバエラー)
  2. 設計規約 §2 または §2.3 に「レスポンスコード列挙順序」セクションを追加
  3. api/openapi.yaml の全エンドポイントを統一ルールに揃える(本作業は別 PR で一括実施を推奨)

受け入れ条件

  • 設計規約に並び順ルールが明文化されている
  • OpenAPI 全エンドポイントが新ルールに準拠している
  • 将来の PR レビューで「並び順」を理由とした指摘が出ないこと

参照

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsdocs/ 配下のドキュメント(設計書・規約・ADR 等)変更area/openapiOpenAPI 仕様(api/openapi.yaml)変更claude:ready実装着手 OK のサイン。人が付与すると実装 Claude が起動priority/p3Low。バックログ。余裕があれば対応

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions