REST Issues 실험적 API에서 GA API 마이그레이션 가이드
실험적(Experimental) API에 대한 중요한 정보
실험적 엔드포인트는 불안정한 것으로 간주되며 기술 미리 보기로 간주됩니다. 실험적 버전은 중단되는 변경(Breaking changes)을 도입할 수 있으며 언제든지 중단될 수 있습니다.
GA REST Issues API의 새로운 기능
GA REST Issues API 문서: /groups/{group_id}/issues 및 /orgs/{org_id}/issues. 업데이트된 링크: 조직 ID로 문제 가져오기
이 버전의 API는 다음을 제공합니다.
일관성(Consistency): REST Issues API의 성능 및 신뢰성 향상
심층성(Depth): 오픈소스 패키지 및 수정 사항에 대한 상세한 표현(Representation)
유연성(Flexibility): 맞춤형 API 응답을 위한 새로운 필터
사용성(Usability): 페이지네이션 및 응답 관리 개선으로 API 상호 작용 단순화
Snyk은 새로운 API로 마이그레이션하는 것이 큰 작업이 될 수 있음을 이해하고 있으며, 프로세스 전반에 걸쳐 여러분을 지원하고자 합니다. 이 포괄적인 마이그레이션 가이드는 단계별 지침, 코드 예시 및 모범 사례를 제공하여 새로운 API에 원활하게 통합할 수 있도록 돕기 위해 작성되었습니다.
지원 종료된 엔드포인트를 사용 중인 경우, Snyk은 이 마이그레이션 가이드를 검토하고 모든 자동화 기능을 이전할 것을 권장합니다.
실험적 API와 GA API 비교
실험적 API 문제를 GA API 문제에 매핑하기
아래 표에서 볼 수 있는 주요 차이점 중 하나는 문제의 ID 형식이 실험적 API의 URI 형식(key & scan_item.id로 구성)에서 GA API의 UUID로 변경되었다는 점입니다. 실험적 API 응답의 문제를 GA API 응답의 동일한 문제와 일치시키려면 key와 scan_item.id를 사용할 수 있습니다. scan_item은 relationships 블록의 일부이고 key는 attributes 블록의 일부라는 점에 유의하십시오.
classes
있음
변경 없음
coordinates
클라우드 문제에만 사용 가능
클라우드 및 SCA 문제에 사용 가능하며 새로운 수정 가능성(fixability) 필드가 있음
coordinates.is_fixable_manually
coordinates.is_fixable_snyk
coordinates.is_fixable_upstream
coordinates.is_patchable
coordinates.is_pinnable
coordinates.is_upgradeable
없음
새로 도입된 수정 가능성 데이터
coordinates.reachability
없음
새로 도입됨
coordinates.remedies
있음
변경 없음
representations
있음
새로운 필드
representations.resourcePath
있음
변경 없음
respresentations.dependencyChain
있음
representations.dependency를 위해 제거됨
representations.dependency
없음
새로 도입됨, representations.
dependencyChain을 대체함
representations.dependency
.package_name
representations.dependency.
package_version
없음
represenations.dependency의 일부로 새로 도입됨
cloud_resource
있음
변경 없음
sourceLocation
있음
변경 없음
created_at
있음
변경 없음
description
변경 없음
effective_severity_level
있음
변경 없음
ignored
있음
변경 없음
key
있음
변경 없음
priority
있음
제거되고 risk로 대체됨
priority.factors
있음
risk.factors로 대체됨 [^1]
priority.score
있음
risk.score로 대체됨 [^2]
risk
없음
새로 도입됨, priority를 대체함
status
있음
변경 없음
title
있음
변경 없음
type
있음
변경 없음
updated_at
있음
변경 없음
id
URI 형식 [^3]
UUID
실험적 API와 GA API 필터 비교
starting_after
이 커서 바로 다음의 결과 페이지를 반환
있음
변경 없음
ending_before
이 커서 바로 이전의 결과 페이지를 반환
있음
변경 없음
limit
페이지당 반환할 결과 수
있음
변경 없음
scan_item.id
scan item 관계를 통해 문제를 필터링
있음
변경 없음
scan_item.type
scan item 관계를 통해 문제를 필터링
있음
변경 없음
type
문제 유형별로 필터링
있음
변경 없음
updated_after
이 날짜 이후에 업데이트된 문제 필터링
있음
변경 없음
updated_before
이 날짜 이전에 업데이트된 문제 필터링
없음
새로 도입됨
created_before
이 날짜 이전에 생성된 문제 필터링
없음
새로 도입됨
created_after
이 날짜 이후에 생성된 문제 필터링
없음
새로 도입됨
effective_severity_level
하나 이상의 유효 심각도 수준별로 문제 필터링
없음
새로 도입됨
status
문제 상태별로 필터링
없음
새로 도입됨
ignored
무시 상태별로 문제 필터링
없음
새로 도입됨
Last updated