トピックAPI

プラン: Free、Premium、Ultimate
提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、プロジェクトのトピックを操作します。詳細については、プロジェクトトピックを参照してください。

トピック一覧

関連付けられたプロジェクトの数で順序付けられた、GitLabインスタンス内のプロジェクトのトピックの一覧を返します。

GET /topics

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`page`	整数	いいえ	取得するページ。`1`がデフォルトです。
`per_page`	整数	いいえ	ページごとに返すレコード数。`20`がデフォルトです。
`search`	文字列	いいえ	`name`に対してトピックを検索します。
`without_projects`	ブール値	いいえ	割り当てられたプロジェクトがないトピックに結果を制限します。

リクエスト例:

curl --request GET \
  --url "https://gitlab.example.com/api/v4/topics?search=git"

レスポンス例:

[
  {
    "id": 1,
    "name": "gitlab",
    "title": "GitLab",
    "description": "GitLab is an open source end-to-end software development platform with built-in version control, issue tracking, code review, CI/CD, and more.",
    "total_projects_count": 1000,
    "organization_id": 1,
    "avatar_url": "http://www.gravatar.com/avatar/a0d477b3ea21970ce6ffcbb817b0b435?s=80&d=identicon"
  },
  {
    "id": 3,
    "name": "git",
    "title": "Git",
    "description": "Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.",
    "total_projects_count": 900,
    "organization_id": 1,
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon"
  },
  {
    "id": 2,
    "name": "git-lfs",
    "title": "Git LFS",
    "description": null,
    "total_projects_count": 300,
    "organization_id": 1,
    "avatar_url": null
  }
]

トピックの取得

IDでプロジェクトのトピックを取得します。

GET /topics/:id

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数	はい	プロジェクトのトピックのID

リクエスト例:

curl --request GET \
  --url "https://gitlab.example.com/api/v4/topics/1"

レスポンス例:

{
  "id": 1,
  "name": "gitlab",
  "title": "GitLab",
  "description": "GitLab is an open source end-to-end software development platform with built-in version control, issue tracking, code review, CI/CD, and more.",
  "total_projects_count": 1000,
  "organization_id": 1,
  "avatar_url": "http://www.gravatar.com/avatar/a0d477b3ea21970ce6ffcbb817b0b435?s=80&d=identicon"
}

トピックに割り当てられたプロジェクトの一覧

トピックに割り当てられたすべてのプロジェクトを一覧表示するには、Projects APIを使用します。

GET /projects?topic=<topic_name>

トピックを作成する

新しいプロジェクトのトピックを作成します。管理者のみが使用できます。

POST /topics

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`name`	文字列	はい	Slug (名前)
`title`	文字列	はい	タイトル
`avatar`	ファイル	いいえ	アバター
`description`	文字列	いいえ	説明
`organization_id`	整数	いいえ	トピックの組織ID。警告：この引数は実験段階であり、将来変更される可能性があります。組織の詳細については、Organizations APIを参照してください

リクエスト例:

curl --request POST \
    --data "name=topic1&title=Topic 1" \
    --header "PRIVATE-TOKEN: <your_access_token>" \
    --url "https://gitlab.example.com/api/v4/topics"

レスポンス例:

{
  "id": 1,
  "name": "topic1",
  "title": "Topic 1",
  "description": null,
  "total_projects_count": 0,
  "organization_id": 1,
  "avatar_url": null
}

プロジェクトのトピックの更新

プロジェクトのトピックを更新します。管理者のみが使用できます。

PUT /topics/:id

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数	はい	プロジェクトのトピックのID
`avatar`	ファイル	いいえ	アバター
`description`	文字列	いいえ	説明
`name`	文字列	いいえ	Slug (名前)
`title`	文字列	いいえ	タイトル

リクエスト例:

curl --request PUT \
    --data "name=topic1" \
    --header "PRIVATE-TOKEN: <your_access_token>" \
    --url "https://gitlab.example.com/api/v4/topics/1"

レスポンス例:

{
  "id": 1,
  "name": "topic1",
  "title": "Topic 1",
  "description": null,
  "total_projects_count": 0,
  "organization_id": 1,
  "avatar_url": null
}

トピックアバターのアップロード

ファイルシステムからアバターファイルをアップロードするには、--form引数を使用します。この引数により、cURLはヘッダーContent-Type: multipart/form-dataを使用してデータを送信します。file=パラメータは、ファイルシステムのファイルを指しており、先頭に@を付ける必要があります。例:

curl --request PUT \
    --header "PRIVATE-TOKEN: <your_access_token>" \
    --url "https://gitlab.example.com/api/v4/topics/1" \
    --form "avatar=@/tmp/example.png"

トピックアバターの削除

トピックアバターを削除するには、avatar属性に空白値を指定します。

リクエスト例:

curl --request PUT \
    --data "avatar=" \
    --header "PRIVATE-TOKEN: <your_access_token>" \
    --url "https://gitlab.example.com/api/v4/topics/1"

トピックを削除

プロジェクトのトピックを削除するには、管理者である必要があります。プロジェクトのトピックを削除すると、プロジェクトのトピックの割り当ても削除されます。

DELETE /topics/:id

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数	はい	プロジェクトのトピックのID

リクエスト例:

curl --request DELETE \
    --header "PRIVATE-TOKEN: <your_access_token>" \
    --url "https://gitlab.example.com/api/v4/topics/1"

トピックをマージする

ソーストピックをターゲットトピックにマージするには、管理者である必要があります。トピックをマージすると、ソーストピックが削除され、割り当てられたすべてのプロジェクトがターゲットトピックに移動されます。

POST /topics/merge

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`source_topic_id`	整数	はい	ソースプロジェクトのトピックのID
`target_topic_id`	整数	はい	ターゲットプロジェクトのトピックのID

source_topic_idとtarget_topic_idは同じ組織に属している必要があります。

リクエスト例:

curl --request POST \
    --data "source_topic_id=2&target_topic_id=1" \
    --header "PRIVATE-TOKEN: <your_access_token>" \
    --url "https://gitlab.example.com/api/v4/topics/merge"

レスポンス例:

{
  "id": 1,
  "name": "topic1",
  "title": "Topic 1",
  "description": null,
  "total_projects_count": 0,
  "organization_id": 1,
  "avatar_url": null
}