2.15. repositorynotification

リポジトリーイベント/通知を一覧表示、作成、管理します。

2.15.1. testRepoNotification

このリポジトリーのテスト通知をキューに入れます。

POST /api/v1/repository/{repository}/notification/{uuid}/test

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

uuid
必須

通知の UUID

string

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.2. getRepoNotification

指定した通知の情報を取得します。

GET /api/v1/repository/{repository}/notification/{uuid}

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

uuid
必須

通知の UUID

string

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.3. deleteRepoNotification

指定した通知を削除します。

DELETE /api/v1/repository/{repository}/notification/{uuid}

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

uuid
必須

通知の UUID

string

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コード説明スキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.4. resetRepositoryNotificationFailures

リポジトリーの失敗通知を 0 件にリセットします。

POST /api/v1/repository/{repository}/notification/{uuid}

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

uuid
必須

通知の UUID

string

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.5. createRepoNotification

POST /api/v1/repository/{repository}/notification/

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

要求の body スキーマ (application/json)

リポジトリーでの通知作成に関する情報

名前説明スキーマ

event
任意

通知が応答するイベント

string

method
任意

通知の方法 (メールや Web コールバックなど)

string

config
任意

特定の通知メソッドに関する JSON 設定情報

object

eventConfig
任意

特定の通知イベントに関する JSON 設定情報

object

title
任意

人間が判読できる通知のタイトル

string

レスポンス
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.15.6. listRepoNotifications

指定したリポジトリーの通知を一覧表示します。

GET /api/v1/repository/{repository}/notification/

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError