REST API deprecations and removals

다음 API 변경 사항은 REST API v4와 v5 사이에서 발생할 것입니다.
이 업그레이드에 대한 일정은 설정되지 않았습니다.

자세한 정보는 이슈 216456 및 이슈 387485를 참조하십시오.

geo_nodes API 엔드포인트

중단되었습니다. 관련 이슈.

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

merged_by API 필드

중단되었습니다. 관련 이슈.

병합 요청 API의 merged_by 필드가 간단한 병합 이외의 동작(자동 병합, 병합 트레인에 추가)을 수행할 때 병합 요청을 누가 병합했는지를 더 정확하게 식별하는 merge_user 필드로 대체되었습니다.

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

merge_status API 필드

중단되었습니다. 관련 이슈.

병합 요청 API의 merge_status 필드가 병합 요청이 가질 수 있는 모든 잠재적인 상태를 더 정확하게 식별하는 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 만이 될 것입니다.

단일 병합 요청 변경 API 엔드포인트

중단되었습니다. 관련 이슈.

개별 병합 요청에서 변경 사항 가져오기 엔드포인트가 병합 요청 차이 목록 엔드포인트로 대체되었습니다.
API 사용자는 새로운 차이 엔드포인트로 전환하는 것을 권장받습니다.

단일 병합 요청에서 변경 사항 엔드포인트는 GitLab REST API의 v5에서 제거될 것입니다.

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

중단되었습니다. 관련 이슈.

특정 프로젝트에 대한 모든 관리 라이선스를 가져오는 엔드포인트가 라이선스 승인 정책 기능으로 대체되었습니다.

감지된 라이선스를 기반으로 승인을 계속 적용하려는 사용자는 새로운 라이선스 승인 정책을 만드는 것이 좋습니다.

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

병합 요청 승인 API의 승인자 및 승인자 그룹 필드

중단되었습니다. 관련 이슈.

프로젝트에 대한 승인 구성을 가져오는 엔드포인트는 approvers 및 approval_groups에 대해 빈 배열을 반환합니다.
이러한 필드는 병합 요청에 대한 프로젝트 수준 규칙 엔드포인트를 사용하는 것으로 대체되었습니다. API 사용자는 이 엔드포인트로 전환하는 것을 권장받습니다.

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

Runner 사용의 active가 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에서 러너 API는 러너의 ip_address 대신에 ""을 반환할 것입니다.
REST API의 v5에서 이 필드는 제거될 것입니다.

Runner는 version, revision, platform, 또는 architecture를 반환하지 않을 것입니다

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

GitLab 18.0에서 Runners 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에서 제거될 것입니다.

require_password_to_approve API 필드

require_password_to_approve는 GitLab 16.9에서 사용 중지되었습니다. 대신 require_reauthentication_to_approve 필드를 사용하세요. 두 필드에 값을 제공하는 경우 require_reauthentication_to_approve 필드가 우선합니다.

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