公開APIでレビュー依頼を扱えるようになりました！

ベースマキナの更新情報をお届けします。

公開APIで、レビューが必須のアクションに対するレビュー依頼の作成・状態取得・承認後の実行を提供開始しました。CI/CDや外部システムから、レビュー必須のアクションを「依頼 → 承認 → 実行」の流れで呼び出せます。

これまでの課題

レビュー設定でレビューが必須のアクションは、安全のため公開APIから直接実行できず403 forbiddenを返します。そのため、これまではレビューを必須にしたアクションを公開API経由で呼び出せませんでした。

今回の対応で、このようなアクションも公開APIからレビュー依頼を作成し、承認後に実行できるようになりました。

使い方

レビュー必須のアクションは、次の3ステップで実行します。トークンはbm loginで取得したものを使います。

1. レビュー依頼を作成する

アクションのreview-requestsエンドポイントに、実行引数（arguments）・説明（description）・有効期限（expiration）を渡してレビュー依頼を作成します。

export BM_TOKEN=$(bm print-access-token)

curl -X POST \
  "$BASE/public/v1/projects/{project_id}/environments/{environment_id}/actions/{action_id}/review-requests" \
  -H "Authorization: Bearer $BM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "arguments": { "email": "user@example.com" },
    "description": "メール送信の承認をお願いします",
    "expiration": { "type": "datetime", "expires_at": "2026-07-01T00:00:00+09:00" }
  }'

レスポンスにはreview_request_idと現在のstatus（作成直後はrequested）が含まれます。

{
  "review_request_id": "rvr_xxxxx",
  "action_id": "send_email",
  "status": "requested",
  "expiration": { "type": "datetime", "expires_at": "2026-07-01T00:00:00.000Z" }
}

2. 承認状態を確認する

作成したレビュー依頼の状態を取得します。statusがapprovedになれば実行できます。

curl "$BASE/public/v1/projects/{project_id}/environments/{environment_id}/review-requests/{review_request_id}" \
  -H "Authorization: Bearer $BM_TOKEN"

3. 承認後に実行する

statusがapprovedになったら、executionsエンドポイントを呼び出してアクションを実行します。

curl -X POST \
  "$BASE/public/v1/projects/{project_id}/environments/{environment_id}/review-requests/{review_request_id}/executions" \
  -H "Authorization: Bearer $BM_TOKEN" \
  -H "Content-Type: application/json"

承認前に実行しようとすると409 state_conflictを返します。

ご利用にあたって

• レビュー依頼の作成・実行は、bm loginで取得したJWT（ログインしたユーザー）でのみ行なえます。サービスアカウントでは403 forbiddenになります。

• 有効期限は、日時指定（{ "type": "datetime", "expires_at": ... }）と無期限（{ "type": "never" }）から選べます。

詳細はドキュメントの「公開API」および「APIリファレンス」をご参照ください。