API End of Life (EOL) 프로세스 및 마이그레이션 가이드

이 페이지에서는 모든 API 엔드포인트에 대한 종료(End-of-life, EOL)주기와 관련된 프로세스, 주요 날짜 및 이벤트에 대해 설명합니다. 본 문서에서는 또한 종료 진행 중인 API 엔드포인트를 위한 주요 날짜마이그레이션 가이드에 대한 상세 정보를 찾을 수 있습니다.

API End of Life (EOL) 프로세스

Snyk GA REST API는 다음과 같은 기능을 갖춘 Snyk V1 API의 진화된 API입니다:

  • 일관된 버전 관리

  • 페이지네이션 및 캐싱

  • 향상된 성능

  • 클라이언트 생성을 위한 명세서

Snyk의 V1 API에 대한 EOL 및 GA REST API로의 교체는 해당 개선 사항을 V1 API에 구현합니다. Snyk이 더 많은 GA REST API를 제공하는 동안 REST API의 실험 및 베타 버전도 종료 단계에 도달할 것입니다.

V1 API에서 GA REST로의 마이그레이션은 시간이 많이 걸릴 수 있으며, Snyk은 마이그레이션을 고려하고 실행할 충분한 시간이 있도록 하여 가능한 빨리 최상의 API 경험을 할 수 있도록 하고자 합니다. V1, 실험 또는 베타 API를 EOL로 처리하여 GA REST로의 원활한 마이그레이션하는 과정은 다음과 같습니다:

  1. 엔드포인트의 일괄 처리는 매년 두 번 시작되는 EOL 주기의 일부가 됩니다: 1월에 한 번 및 7월에 한 번.

  2. API 엔드포인트를 EOL에 포함시킬 수 있는 조건은 다음과 같습니다:

    • GA REST와 동등한 버전이 있어야 합니다 (V1 API가 GA REST와 동등한 버전이 필요하지 않은 드문 경우를 제외하고)

    • V1 및 GA REST 간의 기능 동등성 (이동 가이드에서 명시적으로 다르게 명시되지 않는 한)

    • 이동 용이성을 위해 당사의 필드 전문가에 의해 마이그레이션 가이드가 있어야 합니다.

  3. Snyk은 EOL 주기가 시작되는 한 달 전에 공개적으로 공지합시다.

  4. EOL이 시작되는 날, 엔드포인트는 폐기 예정으로 간주됩니다. 이 시점에서 각 엔드포인트의 문서는 제거되거나 해당 엔드포인트가 폐기 예정임을 나타내는 문구가 추가됩니다. 게다가, 새로운 고객은 해당 엔드포인트와 통합할 수 없습니다. 기존 고객은 종료 날짜까지 해당 엔드포인트를 계속 사용할 수 있습니다. 종료 예정이 밝혀진 모든 엔드포인트와 관련 타임라인은 API EOL 엔드포인트 및 주요 날짜 페이지에서 찾을 수 있습니다.

  5. EOL 주기 동안 매월, Snyk은 지명된 엔드포인트의 기능을 일시적으로 중단하고 EOL 기간 동안 지속적으로 지속 시간을 늘릴 것입니다.

  6. EOL 날짜에 도달하면 엔드포인트가 작동을 중단하고 오류가 발생합니다.

API EOL 유형

각 주기 동안 다음과 같은 EOL 유형이 발생할 것입니다:

  1. V1 API: GA REST 동등 버전이 나올 때, Snyk은 가능한 한 빨리 V1 API를 EOL 주기에 포함시킬 것입니다. 사용자는 1월 및 7월에 공개적으로 발표가 시작되는 시점부터 6개월 제공될 것입니다.

  2. 실험 및 베타: Snyk이 GA로 REST 엔드포인트를 업그레이드하면 이전 실험 또는 베타 엔드포인트 또는 둘 다에 대해 가능한 한 빨리 EOL 주기에 포함시킬 것입니다. 사용자는 엔드포인트 마이그레이션을 시작하려면 공개적으로 발표되기 시작한 시점부터 3개월을 제공받게 될 것입니다.

예외적인 경우에는 Snyk이 매년 1월과 7월의 두 공지 외에 엔드포인트에 대한 EOL을 발표해야 할 수도 있습니다. 사용자는 EOL 주기에 대한 1개월 알림을 받게 될 것입니다. 엔드포인트에서 마이그레이션할 시간 창은 V1 API 또는 실험 또는 베타 엔드포인트 각 유형에 대해 식별된 동일한 화면을 따를 것입니다.

Last updated