버전과 지원 종료
SDK 업그레이드와 API 변경에 대응합니다.
API는 현재 배포된 서비스를 제공합니다. SDK 패키지 버전은 사용할 클라이언트 코드를 정하며 과거 API 응답을 선택하지 않습니다. OpenAPI 버전은 API 문서의 버전입니다. 직접 HTTP 요청도 같은 배포 서비스를 사용합니다.
업그레이드 준비
| 변경 | 릴리스와 이행 |
|---|---|
| 호환되는 추가 | SDK 기능은 minor 릴리스로 제공하며 기존 응답 처리와 호환되어야 합니다 |
| SDK 1.0 이전 호환성이 깨지는 변경 | BREAKING (0.x minor)로 표시한 SDK minor 릴리스에 이행 절차를 제공합니다 |
| SDK 1.0 이후 호환성이 깨지는 변경 | SDK major 릴리스에 이행 절차를 제공합니다 |
업그레이드 전에 이행 안내와 최소 지원 SDK 버전을 확인하세요. 앱의 의존성 설정에 지원 버전을 반영하고 영향을 받는 요청을 확인하세요. 직접 HTTP로 연동한다면 공개된 요청과 응답의 이행 예시를 따르세요.
변경 고지와 지원 종료
서비스에 유료 워크스페이스가 생긴 뒤 API 호환성을 깨는 변경에는 최소 30일의 고지와 이행 기간을 둡니다. 소비자 고지와 사용 가능한 대체 수단이 모두 준비된 시점부터 계산합니다. 호환 SDK가 필요하다면 그 릴리스도 준비되어야 합니다. 기능별로 더 긴 기간을 약속했다면 그 기간을 적용합니다.
유료 워크스페이스가 생기기 전에는 1.0 이전의 변경 릴리스 관행과 기존 기능별 이행 기간을 적용합니다. 중요한 서비스 변경에 대한 약관의 사전 고지는 계속 적용됩니다. 보안과 긴급 변경은 해당 약관을 따릅니다.
아래 SDK 지원 종료 대상 7곳의 가장 이른 제거 목표는 1.0.0입니다. 표에 적힌 대체 API와 import 경로로 이행하세요. 실제 제거는 별도 호환성 변경과 해당 고지·이행 기간 충족 후에 진행합니다. 준비가 끝나지 않으면 목표를 연기하고 다시 고지합니다. 제거 시점에 유료 워크스페이스 여부를 다시 확인하며, 첫 유료 워크스페이스 전에 세운 계획도 이후에는 최소 30일을 적용합니다. 목표를 앞당길 때에는 기간을 충족하는 새 고지가 필요합니다.
| 지원 종료 대상 | 대체 API와 이행 방법 | 가장 이른 목표 |
|---|---|---|
ProductMediaResolutionSource | @01.software/sdk에서 선택 결과에는 ProductSelectionMediaSource, 표시 대체 결과에는 ProductDisplayMediaSource를 가져오세요. 둘 다 저장한다면 두 타입의 유니온을 사용하세요. | 1.0.0 |
Comment | @01.software/sdk에서 CommunityComment를 가져오고 타입 참조 이름을 바꾸세요. 형태는 같습니다. | 1.0.0 |
community.addReaction({ type }) | @01.software/sdk의 createClient로 만든 클라이언트에서 입력 키를 typeSlug로 바꾸고 기존 슬러그 값을 유지하세요. | 1.0.0 |
community.addCommentReaction({ type }) | 같은 클라이언트에서 입력 키를 typeSlug로 바꾸고 기존 슬러그 값을 유지하세요. | 1.0.0 |
customer.auth.logout() | 같은 클라이언트에서 customer.auth.logoutAsync()를 await하고 오류를 처리하세요. 서버 폐기에 실패해도 로컬 인증 정보는 지워집니다. 액세스 토큰만 있는 기존 세션에는 폐기할 갱신 토큰 계열이 없습니다. | 1.0.0 |
WebhookOptions | @01.software/sdk/webhook에서 SignedWebhookOptions를 가져오세요. 필수인 비어 있지 않은 secret과 선택 항목인 toleranceSeconds를 유지하세요. | 1.0.0 |
handleWebhook() | @01.software/sdk/webhook에서 handleSignedWebhook를 가져와 같은 요청, 핸들러, 서명 옵션을 전달하세요. | 1.0.0 |
동기 로그아웃 메서드는 로컬 인증 정보만 지웁니다. 비동기 대체 메서드는 현재 직접
로그인 세션의 갱신 토큰 계열도 폐기합니다. 서명 웹훅 대체 메서드는 원본 본문 검증과
서명 비밀 값의 정확한 바이트를 유지합니다. 기존 웹훅 이름 두 개는 루트와 웹훅
경로에서 계속 사용할 수 있으며, 명시적 서명 수신기는 웹훅 경로에서 가져옵니다.
removeReaction과 removeCommentReaction의 type 입력 이름은 유지하세요.
이행 안내와 고지에서 최소 지원 버전과 전환 일정을 확인하세요. 현재 API는
Deprecation이나 Sunset 응답 헤더 대신 이 안내로 변경 일정을 전달합니다.
응답 호환성
SDK에서 작업에 맞는 전용 메서드를 먼저 사용하세요. 일부 메서드는 응답 전체를 검증하고 정의되지 않은 필드를 거부합니다. 새 SDK 타입에서 선택 항목인 필드도 이전 SDK에서는 이행이 필요할 수 있습니다.
기능 문서에 정확한 Accept 미디어 타입이 있다면 그 값을 보내 추가 응답 형식을
요청하세요. 그 외 요청에는 해당 기능의 기본 응답을 제공합니다. 기본 응답이
바뀌는 경우 기능별 전환 안내를 따르세요. SDK 1.0에서도 기존 응답 검증 경계를
유지합니다.
다음 액션
영향을 받는 연동에 따라 SDK 안내, HTTP API 안내, 웹훅 안내로 이어가세요.