Policy

warning

아래 정책들은 General Availability 버전 출시 이후부터 적용 됩니다.

Backward Compatibility

API 가 지속적으로 개선됨에 따라 동일 API 에 대한 명세가 일부 달라지는 경우가 존재 합니다.

대표적으로 Enum 값이 추가된다거나 하는 경우가 존재할 수 있습니다. 이러한 변경에 대한 영향은 사용자에 따라 영향이 다르며, 경우에 따라서는 일반적인 동작 뿐만 아니라 버그까지 재현되길 원하는 경우가 발생할 수 있습니다.

이에 따라 딜리버리 트래커는 하위 호환을 보장하여 API 변경으로 인한 사용자의 영향 범위 줄이고자 API Version Request Header 를 제공 하고 있습니다.

별도로 정의되지 않은 경우 latest-stable 로 버전으로 간주 됩니다.

trackql-api-version: latest-stable

노트

TrackQL 은 딜리버리 트래커 Cloud 시스템의 코드네임 입니다.

Backward Compatibility 제공 범위는 사용자가 사용하고 있는 Service Plan 에 따라 차이가 존재하며, General Availability 릴리즈 이전 Preview 기간에는 latest-stable 만 제공 됩니다.

[TBA - 자세한 사항은 contact@tracker.delivery 으로 문의 바랍니다]

warning

기존 API 명세에 정의되어 있지만 잘 사용되지 않는 명세가 존재할 수 있습니다. 이 경우 향후 사용될 수 있으니 구현 시에 유의 바랍니다. (예시 : TrackStatusCode.UNKNOWN 가 잘 사용하지 않지만 구현이 누락된 경우 상위 호환에 어려움이 존재)

Deprecated 예정이 된 API 의 경우 일반적인 경우 발표 시점 부터 1년 이후에 제거를 기준으로 하고 있습니다. 이 시점은 서비스 안정성, 사용량 등에 따라 사전 공지 후 변동될 수 있습니다.

Experimental API 의 경우 위의 Policy 와 별개로 별도의 안내 없이 언제든지 수정 / 추가 / 삭제 될 수 있습니다.