REST API 사용 중단 및 제거

다음과 같은 API 변경 사항이 REST API v4와 v5 사이에서 발생할 것입니다. 이 업그레이드의 날짜는 아직 결정되지 않았습니다.

자세한 내용은 이슈 216456 및 이슈 387485를 참조하세요.

geo_nodes API 엔드포인트

파괴적인 변경. 관련 이슈.

geo_nodes API 엔드포인트는 사용이 중단되었으며 geo_sites로 대체되었습니다. 이는 Geo 배포를 참조하는 방법에 대한 전체적인 변경 중 일부입니다. 노드는 응용 프로그램 전반에서 사이트로 이름이 변경되었습니다. 두 엔드포인트의 기능은 여전히 동일합니다.

merged_by API 필드

파괴적인 변경. 관련 이슈.

Merge Request API의 merged_by 필드가 단순 Merge 이외의 작업(자동 Merge, Merge 열에 추가)을 수행할 때 Merge Request을 Merge한 사용자를 올바르게 식별하는 merge_user 필드로 대체되어 사용이 중단되었습니다.

API 사용자는 대신 새로운 merge_user 필드를 사용할 것을 권장합니다. merged_by 필드는 GitLab REST API의 v5에서 제거될 것입니다.

merge_status API 필드

파괴적인 변경. 관련 이슈.

Merge Request API의 merge_status 필드가 Merge Request이 가질 수 있는 모든 잠재적인 상태를 더 정확하게 식별하는 detailed_merge_status 필드로 대체되어 사용이 중단되었습니다. API 사용자는 대신 새로운 detailed_merge_status 필드를 사용할 것을 권장합니다. merge_status 필드는 GitLab REST API의 v5에서 제거될 것입니다.

사용자 API의 private_profile 속성에 대한 null 값

파괴적인 변경. 관련 이슈.

API를 통해 사용자를 생성하고 업데이트할 때 null은 private_profile 속성의 유효한 값이었으며, 내부적으로 기본값으로 변환되었습니다. GitLab REST API v5에서는 더 이상 이 매개변수에 대해 null이 유효한 값이 아니며 사용할 경우 400 응답이 반환될 것입니다. 이 변경 이후에는 유효한 값은 true와 false 뿐입니다.

단일 Merge Request 변경 API 엔드포인트

파괴적인 변경. 관련 이슈.

단일 Merge Request의 변경 내용을 가져오는 엔드포인트가 Merge Request의 변경 사항 디렉터리 엔드포인트로 대체되어 사용이 중단되었습니다. API 사용자는 새로운 변경 내용 엔드포인트로 전환할 것을 권장합니다.

단일 Merge Request의 변경 내용을 가져오는 엔드포인트는 GitLab REST API의 v5에서 제거될 것입니다.

관리되는 라이선스 API 엔드포인트

파괴적인 변경. 관련 이슈.

특정 프로젝트에 대한 모든 관리되는 라이선스를 가져오는 엔드포인트가 라이선스 승인 정책 기능으로 대체되어 사용이 중단되었습니다. 라이선스가 감지된 내용에 기반한 승인을 계속하려는 사용자는 새로운 라이선스 승인 정책을 만드는 것을 권장합니다.

관리되는 라이선스 엔드포인트는 GitLab REST API의 v5에서 제거될 것입니다.

Merge Request 승인 API의 승인자 및 승인 그룹 필드

파괴적인 변경. 관련 이슈.

프로젝트의 승인 구성을 가져오는 엔드포인트는 approvers 및 approval_groups에 대해 빈 배열을 반환합니다. 이러한 필드들은 Merge Request을 위한 프로젝트 수준 규칙을 가져오는 엔드포인트를 대신하여 사용이 중단되었습니다. API 사용자는 새로운 엔드포인트로 전환할 것을 권장합니다.

이러한 필드들은 GitLab REST API의 v5에서 구성 가져오기 엔드포인트에서 제거될 것입니다.

active의 Runner 사용이 paused로 대체됨

파괴적인 변경. 관련 이슈.

GitLab Runner GraphQL API 엔드포인트에서 active 식별자가 GitLab 16.0에서 paused로 이름이 변경될 것입니다.

  • REST API의 v4에서 active 대신 paused 속성을 사용할 수 있습니다.
  • REST API의 v5에서 이러한 변경은 다음과 같은 active 속성을 사용하거나 반환하는 엔드포인트에 영향을 미칠 것입니다:
    • GET /runners
    • GET /runners/all
    • GET /runners/:id / PUT /runners/:id
    • PUT --form "active=false" /runners/:runner_id
    • GET /projects/:id/runners / POST /projects/:id/runners
    • GET /groups/:id/runners

GitLab Runner의 16.0 릴리스에서는 러너 등록 시 paused 속성을 사용할 것입니다.

Runner 상태가 paused를 반환하지 않음

파괴적인 변경. 관련 이슈.

미래의 REST API v5에서 GitLab Runner의 엔드포인트는 paused 또는 active를 반환하지 않을 것입니다.

러너의 상태는 러너 연락처 상태와만 관련이 있을 것이며 다음과 같을 것입니다: online, offline, 또는 not_connected. 상태 paused 또는 active는 더 이상 나타나지 않을 것입니다.

API 사용자가 paused인지 확인하는 경우 paused 속성이 true인지 확인하는 것이 좋습니다. active인지 확인하는 경우 paused가 false인지 확인하세요.

Runner가 ip_address를 반환하지 않음

파괴적인 변경. 관련 이슈.

GitLab 17.0에서 Runner API는 러너의 ip_address 대신 ""을 반환할 것입니다. REST API v5에서 이 필드는 제거될 것입니다.

Runner가 version, revision, platform, 또는 architecture을 반환하지 않음

파괴적인 변경. 관련 이슈.

GitLab 18.0에서 Runner API는 러너의 version, revision, platform, 및 architecture 대신 ""을 반환할 것입니다. REST API v5에서 이 필드는 제거될 것입니다.

default_branch_protection API 필드

파괴적인 변경. 관련 이슈.

다음의 API에 대해 default_branch_protection 필드가 GitLab 17.0에서 사용이 중단되었습니다:

대신 더 세분화된 기본 브랜치 보호를 제공하는 default_branch_protection_defaults 필드를 사용해야 합니다.

default_branch_protection 필드는 GitLab REST API의 v5에서 제거될 것입니다.