REST API 사용 중단 및 제거
다음 API 변경 사항은 REST API v4와 v5 사이에 발생할 것입니다.
업그레이드 날짜는 설정되지 않았습니다.
자세한 내용은 issue 216456와 issue 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를 통해 사용자를 생성하고 업데이트할 때 private_profile 속성에 대한 null은 유효한 값이었으며 내부적으로 기본값으로 변환되었습니다.
GitLab REST API의 v5에서는 null이 이 매개변수에 대한 유효한 값이 아니게 되며, 사용 시 응답은 400이 됩니다.
이 변경 후 유효한 값은 true와 false뿐입니다.
단일 병합 요청 변경 API 엔드포인트
중단 예정입니다. 관련 문제.
단일 병합 요청의 변경 내용을 가져오는 엔드포인트는
list merge request diffs 엔드포인트로 사용 중단됩니다.
API 사용자는 새로운 diffs 엔드포인트로 전환하도록 권장됩니다.
단일 병합 요청의 변경 내용 엔드포인트는 GitLab REST API의 v5에서 제거됩니다.
관리 라이선스 API 엔드포인트
중단 예정입니다. 관련 문제.
주어진 프로젝트에 대한 모든 관리 라이선스를 가져오는 엔드포인트는 License Approval policy 기능으로 사용 중단됩니다.
감지된 라이선스를 기반으로 승인을 강제하려는 사용자는 대신 새로운 License Approval policy를 생성하도록 권장됩니다.
managed licenses 엔드포인트는 GitLab REST API의 v5에서 제거됩니다.
병합 요청 승인을 위한 승인자 및 승인자 그룹 필드 API
해-breaking change. 관련 이슈.
프로젝트의 승인 구성 가져오기 엔드포인트는
approvers 및 approval_groups에 대해
빈 배열을 반환합니다.
이 필드는 병합 요청의 get project-level rules를 위한 엔드포인트로 대체되었습니다. API 사용자는 이 엔드포인트로 전환할 것을 권장합니다.
이 필드는 GitLab REST API v5의
get configuration 엔드포인트에서 제거될 것입니다.
active의 Runner 사용이 paused로 대체됨
해-breaking change. 관련 이슈.
GitLab Runner GraphQL API 엔드포인트에서
active 식별자의 발생은 GitLab 16.0에서
paused로 이름이 변경됩니다.
- v4의 REST API에서는
active대신paused속성을 사용할 수 있습니다. - v5의 REST API에서는 이 변경이
active속성을 취하거나 반환하는 엔드포인트에 영향을 미칠 것입니다. 예:GET /runnersGET /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를 반환하지 않음
해-breaking change. 관련 이슈.
REST API v5의
미래의 GitLab Runner 엔드포인트는 paused나
active를 반환하지 않을 것입니다.
러너의 상태는
online, offline, 또는 not_connected와 같은
러너 연락 상태와 관련이 있습니다.
상태 paused 또는 active는 더 이상 표시되지 않을 것입니다.
러너가 paused인지 확인할 때,
API 사용자는 대신 불리언 속성 paused가
true인지 확인할 것을 권장합니다.
러너가 active인지 확인할 때는
paused가 false인지 확인하십시오.
Runner는 ip_address를 반환하지 않음
해-breaking change. 관련 이슈.
GitLab 17.0에서,
Runners API는
러너에 대해 ip_address 대신 ""를 반환할 것입니다.
REST API v5에서는 이 필드가 제거될 것입니다.
Runner는 version, revision, platform, 또는 architecture를 반환하지 않음
해-breaking change. 관련 이슈.
GitLab 18.0에서,
Runners API는
러너에 대해 version, revision, platform,
및 architecture 대신 ""를 반환할 것입니다.
REST API v5에서는 이 필드들이 제거될 것입니다.
default_branch_protection API 필드
해-breaking change. 관련 이슈.
default_branch_protection 필드는
다음 API에 대해 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에서 제거될 것입니다.
도움말