背景
PR #179 のレビューで、api/openapi.yaml の各エンドポイントでレスポンスコード列挙順序が不統一であることが指摘された:
| エンドポイント |
現状の順序 |
| GET /api/tasks/{id} |
200 → 404 → 401 → 403 |
| PUT /api/tasks/{id} |
200 → 403 → 404 → 401 |
| DELETE /api/tasks/{id} |
204 → 403 → 404 → 401 |
| PATCH /api/tasks/{id}/visibility |
200 → 400 → 403 → 404 → 401 |
| POST /api/tasks/{id}/stakeholders |
201 → 400 → 401 → 403 → 404 → 409 |
PR #179 が触れた箇所も含む既存問題で、本 PR の範囲外として別 Issue 化された。
やること
- 統一ルールを策定
- 推奨候補:
2xx(成功) → 4xx(クライアントエラー昇順: 400 → 401 → 403 → 404 → 409 → 422)→ 5xx(サーバエラー)
- 設計規約 §2 または §2.3 に「レスポンスコード列挙順序」セクションを追加
api/openapi.yaml の全エンドポイントを統一ルールに揃える(本作業は別 PR で一括実施を推奨)
受け入れ条件
- 設計規約に並び順ルールが明文化されている
- OpenAPI 全エンドポイントが新ルールに準拠している
- 将来の PR レビューで「並び順」を理由とした指摘が出ないこと
参照
背景
PR #179 のレビューで、
api/openapi.yamlの各エンドポイントでレスポンスコード列挙順序が不統一であることが指摘された:200→404→401→403200→403→404→401204→403→404→401200→400→403→404→401201→400→401→403→404→409PR #179 が触れた箇所も含む既存問題で、本 PR の範囲外として別 Issue 化された。
やること
2xx(成功) →4xx(クライアントエラー昇順: 400 → 401 → 403 → 404 → 409 → 422)→5xx(サーバエラー)api/openapi.yamlの全エンドポイントを統一ルールに揃える(本作業は別 PR で一括実施を推奨)受け入れ条件
参照