グループバッジAPI

GitLab 10.6で導入されました。

プレースホルダトークン

バッジは、リンクと画像URLの両方でリアルタイムに置換されるプレースホルダをサポートしています。許可されるプレースホルダは次のとおりです：

  • %{project_path}: プロジェクトパスで置き換えられます。
  • %{project_title}: プロジェクトのタイトルに置き換えます。
  • %{project_name}: プロジェクト名に置き換えてください。
  • %{project_id}: プロジェクトIDに置き換えられます。
  • %{default_branch}: プロジェクトのデフォルト・ブランチに置き換えられます。
  • %{commit_sha}: 直近のプロジェクトのコミットSHAに置き換えられます。

これらのエンドポイントはプロジェクトのコンテキスト内にないので、プレースホルダを置き換えるために使われる情報は最初のグループのプロジェクトの作成日時から得られます。グループにプロジェクトがない場合は、プレースホルダを含む元の URL が返されます。

グループのすべてのバッジをリストアップ

グループのバッジの一覧を取得します。

GET /groups/:id/badges
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するグループのIDまたはURLエンコードされたパス
name文字列です。いいえ返すバッジの名前（大文字と小文字を区別します）。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges?name=Coverage"

応答例

[
  {
    "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": "group"
  }
]

グループのバッジの取得

グループのバッジを取得します。

GET /groups/:id/badges/:badge_id
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するグループのIDまたはURLエンコードされたパス
badge_id整数。yesバッジID
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"

応答例

{
  "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": "group"
}

グループにバッジを追加します。

グループにバッジを追加します。

POST /groups/:id/badges
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するグループのIDまたはURLエンコードされたパス
link_url文字列です。yesバッジリンクのURL
image_url文字列です。yesバッジ画像のURL
name文字列です。いいえバッジの名前
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&name=mybadge&position=0" \
     "https://gitlab.example.com/api/v4/groups/:id/badges"

応答例

{
  "id": 1,
  "name": "mybadge",
  "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": "group"
}

グループのバッジの編集

グループのバッジを更新します。

PUT /groups/:id/badges/:badge_id
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するグループのIDまたはURLエンコードされたパス
badge_id整数。yesバッジID
link_url文字列です。いいえバッジリンクのURL
image_url文字列です。いいえバッジ画像のURL
name文字列です。いいえバッジの名前
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"

応答例

{
  "id": 1,
  "name": "mybadge",
  "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": "group"
}

グループからバッジを削除します。

グループからバッジを削除します。

DELETE /groups/:id/badges/:badge_id
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するグループのIDまたはURLエンコードされたパス
badge_id整数。yesバッジID
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/badges/:badge_id"

グループからバッジをプレビュー

プレースホルダの補間を解決した後のlink_url とimage_url の最終的な URL を返します。

GET /groups/:id/badges/render
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するグループのIDまたはURLエンコードされたパス
link_url文字列です。yesバッジリンクのURL
image_url文字列です。yesバッジ画像のURL
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/: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"
}