Bundle Commit
BundleのバージョンをコミットするAPIです。コミットを行うことで、特定の時点でのアセットの状態を別アセットに複製します。これにより、バージョン間によるデータの変更や追加等の比較が容易になります。
処理の流れとしては、まず、指定されたバージョンを元に新規バージョンが参照するアセットを新規作成します。次に、コミット情報をCloneアセットにcommitId(NewtZeroで自動発行されます。), bundleId, バージョンと新規バージョンのアセット情報が登録されます。最後に、Cloneアセットを元にデータの複製処理が実行されてcommitが完了となります。ただし、commit APIを返すのはClone情報が登録に成功した段階でレスポンスを返すため、データが正常に複製されたか確認する際はしばらく待ってからご確認ください。
データの複製にはnCloneというOptXが必要であり、NewtZeroに対して、定期的に複製するデータがないか(Cloneアセットに複製が完了していないデータが存在するか)をポーリング機能によって監視します。
Path Parameters |
---|
bundleId string — REQUIREDBundleで一意の識別子(ID)です。bundleIdはバージョン間で共通です。 |
version string — REQUIREDBundleのバージョンです。データセットやソースコードの履歴を管理します。このバージョンのデータを元に新規バージョンのデータを複製します。現在はメインブランチのみ(Bundle.isDefault = true)対応しています。 |
Request Body — REQUIRED |
---|
version string新規バージョンの名前です。 |
comment string新規バージョンのコメントです。バージョンの変更点など説明する際に用います。 |
Responses |
---|
200 成功したメッセージを返します。 |
400 新規バージョン名がBundleに既に存在している場合、400エラーを返します。 |
401 headersにAPIキーを送信していない場合に認証エラーとして返します。 |
404 Bundleが見つからない場合、もしくは指定したBundleのバージョンが見つからない場合に404エラーとして返します。 |
500 データベース側のエラーが発生した場合、または送信したデータが無効の場合、500エラーを返します。 |