11.3. API を使用した通知の作成

手順

1. リポジトリーに通知を作成するには、次の POST/api/v1/repository/{repository}/notification コマンドを入力します。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     --data '{
       "event": "<event>",
       "method": "<method>",
       "config": {
         "<config_key>": "<config_value>"
       },
       "eventConfig": {
         "<eventConfig_key>": "<eventConfig_value>"
       }
     }' \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification/

   Copy to Clipboard Toggle word wrap

   このコマンドは CLI に出力を返しません。代わりに、次の GET/api/v1/repository/{repository}/notification/{uuid} コマンドを入力して、リポジトリー通知に関する情報を取得できます。

   {"uuid": "240662ea-597b-499d-98bb-2b57e73408d6", "title": null, "event": "repo_push", "method": "quay_notification", "config": {"target": {"name": "quayadmin", "kind": "user", "is_robot": false, "avatar": {"name": "quayadmin", "hash": "b28d563a6dc76b4431fc7b0524bbff6b810387dac86d9303874871839859c7cc", "color": "#17becf", "kind": "user"}}}, "event_config": {}, "number_of_failures": 0}

   Copy to Clipboard Toggle word wrap

2. 次の POST/api/v1/repository/{repository}/notification/{uuid}/test コマンドを入力して、リポジトリー通知をテストできます。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>/test

   Copy to Clipboard Toggle word wrap

   出力例

   {}

   Copy to Clipboard Toggle word wrap

3. 次の POST/api/v1/repository/{repository}/notification/{uuid} コマンドを入力すると、リポジトリー通知の失敗を 0 にリセットできます。

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>

   Copy to Clipboard Toggle word wrap

4. リポジトリー通知を削除するには、次の DELETE/api/v1/repository/{repository}/notification/{uuid} コマンドを入力します。

   $ curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification/<uuid>

   Copy to Clipboard Toggle word wrap

   このコマンドは CLI に出力を返しません。代わりに、次の GET/api/v1/repository/{repository}/notification/ コマンドを入力して、すべての通知のリストを取得できます。

   $ curl -X GET  -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification

   Copy to Clipboard Toggle word wrap

   出力例

   {"notifications": []}

   Copy to Clipboard Toggle word wrap