이 API를 사용하여 프로젝트 토픽과 상호작용합니다. 자세한 내용은 프로젝트 토픽을 참조하세요.

모든 토픽 목록#

연관된 프로젝트 수에 따라 정렬된 GitLab 인스턴스의 프로젝트 토픽 목록을 반환합니다.

GET /topics

지원되는 속성:

요청 예시:

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

지원되는 속성:

요청 예시:

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

지원되는 속성:

요청 예시:

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

지원되는 속성:

요청 예시:

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

지원되는 속성:

요청 예시:

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

토픽 병합#

소스 토픽을 대상 토픽으로 병합하려면 관리자여야 합니다. 토픽을 병합하면 소스 토픽이 삭제되고 모든 할당된 프로젝트가 대상 토픽으로 이동합니다.

POST /topics/merge

지원되는 속성:

요청 예시:

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
}