프로젝트 문제 경로 API 엔드포인트

다음은 모든 프로젝트 문제 경로 목록 보기 및 모든 프로젝트 스냅샷 문제 경로 목록 보기 엔드포인트에 대한 API 참조 정보에 추가되는 정보입니다.

paths 엔드포인트는 문제가 도입된 경로에 대한 세부 정보를 제공합니다.

paths 엔드포인트에 대한 요청은 GET 요청입니다. 엔드포인트는 다음 URL에서 사용할 수 있습니다.

• https://api.snyk.io/v1/org/<orgId>/project/<projectId>/issue/<issueId>/paths (모든 프로젝트 문제 경로 목록 보기). 이는 프로젝트의 가장 최근 테스트에서 문제에 대한 경로를 반환합니다.

• https://api.snyk.io/v1/org/<orgId>/project/<projectId>/history/<snapshotId>/issue/<issueId>/paths (모든 프로젝트 스냅샷 문제 경로 목록 보기). 이는 프로젝트의 특정 테스트에서 문제에 대한 경로를 반환합니다.

두 경로 엔드포인트 모두 페이지네이션을 허용하는 쿼리 문자열을 사용할 수 있습니다(예: ?page=2&perPage=500).

기본적으로 100개의 결과가 포함된 첫 번째 페이지가 반환됩니다. 페이지당 최대 1,000개의 결과를 요청할 수 있습니다.

응답의 구조는 다음과 같습니다.

{
    "snapshotId": "6d5813be-7e6d-4ab8-80c2-1e3e2a454553",
    "paths": [...],
    "total": 193,
    "links": {
        "prev": "<https://snyk.io/>...",
        "next": "<https://snyk.io/>...",
        "last": "<https://snyk.io/>..."
    }
}

• snapshotId는 경로가 반환된 프로젝트 스냅샷의 ID입니다.

• total은 스냅샷에서 해당 문제에 대한 전체 경로 수입니다.

• links는 응답 페이지 간의 이동을 위한 편의 링크를 제공합니다. links.next 및 links.prev는 해당 페이지가 존재하는 경우에만 제공됩니다. 예를 들어, 마지막 결과 페이지를 가져올 때는 next 링크가 포함되지 않습니다.

• paths는 배열이며, 각 요소는 종속성 트리(Dependency Tree)를 통과하는 경로입니다. 각 경로는 패키지 기술자(Descriptor)의 배열입니다. 예:

{
    "paths": [
        [
            { "name": "lodash", "version": "4.17.4", "fixVersion": "4.17.20" }
        ],
        [ 
            { "name": "babel-template", "version": "6.26.0", "fixVersion": "6.26.0" },
            { "name": "lodash", "version": "4.17.10" }
        ]
    ]
}

이 예시에서는 lodash 패키지의 두 가지 다른 버전을 통해 문제가 도입됩니다. 하나는 직접 종속성(Direct Dependency)이고 다른 하나는 babel-template을 통한 간접 종속성입니다.

가장 짧은 경로가 먼저 제공됩니다. 문제가 프로젝트 자체에 적용되는 경우 경로의 유일한 요소로 나타납니다. 종속성에 적용되는 문제의 경우, 각 경로는 직접 종속성으로 시작합니다.

경로가 업그레이드 가능한 경우 각 경로의 첫 번째 요소에 fixVersion 속성이 제공됩니다. version 속성과 fixVersion 속성이 동일한 경우, 업그레이드에는 전이적 종속성(Transitive Dependencies)의 재잠금(Re-locking)만 포함됩니다.