API リファレンス

リリース

エンドポイント POST /api/v1/releases

デプロイパイプラインからこれを呼び出します（または blipit releases new を使います）。プロジェクトに GitHub トークンが保存されていれば Blipit が commit を自ら取得し、なければ送信された commit を使います。

1リクエスト

シークレットキーを X-Blipit-Key で渡します。ボディは 2 MB まで：version（必須、256文字まで）、commit と previous_commit（git の sha、7〜40文字の16進）、repo（owner/name）、commits（git log からの任意のリスト：sha、message、author、変更ファイル、250件まで）。previous_commit がない場合、Blipit は前回の release の commit 以降の commit を保持し、最初の release ではヘッドのみを保持します。

sh
curl https://in.blipit.io/api/v1/releases \
  -H "Content-Type: application/json" -H "X-Blipit-Key: <secret key>" \
  -d '{"version":"shop@1.4.2","commit":"9fceb02a","previous_commit":"3a1c7f0d","repo":"acme/shop"}'

2レスポンス

200 {version, commits, source (github, cli or null), previous_commit, warning?}。warning は GitHub の検索が失敗して CLI の commit が使われた場合に示されます。400 は不正な version、sha、repo。401 は不明なキー、403 は公開キー。

知っておくと便利

  • repo は owner/name のみ可。@、//、..、?、# や余分なセグメントを含むものは拒否されるため、GitHub の呼び出しは常に api.github.com/repos/owner/name にのみ到達します。
  • GitHub の compare 取得は10秒でタイムアウトし、最新30件の commit の変更ファイルを読み取ります。

お困りですか？support@blipit.io までメールしてください。各プロジェクトのキーと正確な DSN は app.blipit.io の「APIキー」にあります。