- プレースホルダ・トークン
- プロジェクトのすべてのバッジを一覧表示します。
- プロジェクトのバッジをゲット
- プロジェクトにバッジを追加
- プロジェクトのバッジの編集
- プロジェクトからバッジを削除
- プロジェクトからのバッジのプレビュー
プロジェクトバッジAPI
GitLab 10.6で導入されました。
プレースホルダ・トークン
バッジは、リンクと画像URLの両方でリアルタイムに置換されるプレースホルダをサポートしています。 許可されるプレースホルダは以下のとおりです:
- %{project_path}: はプロジェクトのパスに置き換えられます。
- %{project_id}: はプロジェクトIDに置き換えられます。
- %{default_branch}: プロジェクトのデフォルトブランチに置き換えられます。
- %{commit_sha}: は最後のプロジェクトのコミットshaに置き換えられます。
プロジェクトのすべてのバッジを一覧表示します。
プロジェクトのバッジとそのグループのバッジのリストを取得します。
GET /projects/:id/badges
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス |
name
| 列 | いいえ | 返すバッジの名前 (大文字と小文字は区別されます)。 |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges"
回答例
[
{
"name": "Coverage",
"id": 1,
"link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
"rendered_image_url": "https://shields.io/my/badge",
"kind": "project"
},
{
"name": "Pipeline",
"id": 2,
"link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
"rendered_image_url": "https://shields.io/my/badge",
"kind": "group"
},
]
プロジェクトのバッジをゲット
プロジェクトのバッジを取得します。
GET /projects/:id/badges/:badge_id
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス |
badge_id
| 整数 | はい | バッジID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
回答例
{
"id": 1,
"link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
"rendered_image_url": "https://shields.io/my/badge",
"kind": "project"
}
プロジェクトにバッジを追加
プロジェクトにバッジを追加します。
POST /projects/:id/badges
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス |
link_url
| 列 | はい | バッジリンクのURL |
image_url
| 列 | はい | バッジ画像のURL |
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&position=0" "https://gitlab.example.com/api/v4/projects/:id/badges"
回答例
{
"id": 1,
"link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
"image_url": "https://shields.io/my/badge1",
"rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
"rendered_image_url": "https://shields.io/my/badge1",
"kind": "project"
}
プロジェクトのバッジの編集
プロジェクトのバッジを更新します。
PUT /projects/:id/badges/:badge_id
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス |
badge_id
| 整数 | はい | バッジID |
link_url
| 列 | いいえ | バッジリンクのURL |
image_url
| 列 | いいえ | バッジ画像のURL |
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
回答例
{
"id": 1,
"link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master",
"rendered_image_url": "https://shields.io/my/badge",
"kind": "project"
}
プロジェクトからバッジを削除
プロジェクトからバッジを削除します。 このエンドポイントを使用すると、プロジェクトのバッジのみが削除されます。
DELETE /projects/:id/badges/:badge_id
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス |
badge_id
| 整数 | はい | バッジID |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id"
プロジェクトからのバッジのプレビュー
プレースホルダの補間を解決した後のlink_url
とimage_url
の最終的な URL を返します。
GET /projects/:id/badges/render
属性 | タイプ | 必須 | 説明 |
---|---|---|---|
id
| 整数/文字列 | はい | 認証されたユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス |
link_url
| 列 | はい | バッジリンクのURL |
image_url
| 列 | はい | バッジ画像のURL |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/render?link_url=http%3A%2F%2Fexample.com%2Fci_status.svg%3Fproject%3D%25%7Bproject_path%7D%26ref%3D%25%7Bdefault_branch%7D&image_url=https%3A%2F%2Fshields.io%2Fmy%2Fbadge"
回答例
{
"link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}",
"image_url": "https://shields.io/my/badge",
"rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master",
"rendered_image_url": "https://shields.io/my/badge",
}