freee工数管理 APIでのエラーレスポンスの共通化とステータスコードの整理

freee工数管理 APIの各エンドポイントでエラーレスポンスが共通スキーマに統一され、返却されるステータスコードが整理されました。

変更点

  • 400エラーレスポンスにバリデーション対象の項目を示す任意プロパティのfields(nameとmessageの配列)を追加
  • 共通errorスキーマのstatus_codeに列挙値400、401、402、403、404、500を追加
  • 共通errorスキーマのerrors内のtypeに列挙値forbidden、internal_server_error、resource_not_foundを追加
  • GET /partners、GET /people、GET /projects、POST /workloadsなど9つのエンドポイントに403エラーレスポンスを追加
  • プロジェクト詳細取得に404、プロジェクト登録に402を追加し、ログインユーザー情報取得の401と人件費予算一覧取得の402を削除

影響範囲

GET /partnersGET /peopleGET /projectsGET /projects/{id}GET /teamsGET /unit_costsGET /workload_summariesGET /workloads

公式ページを開く

この記事は Release Radar が独自に要約したもので、各社の公式発表ではありません。正確な内容は公式ページをお読みください。