Нұсқалау және қолдаудан алу саясаты

Бұл бетте платформаға арнап әзірлегенде нені сүйеніш етуге болатыны және өзгерістің сізге қалай жететіні айтылған.

Нені нұсқалайды

Шарт файлы. OpenAPI файлының info.version мәні, қазір 1.0.0, және жолдағы нұсқа: verify хостында /v1, /api/v1, /d/v1, /s/v1.
Көрсетілімдер пакеті. Пакеттің schema өрісі, қазір tanba.pop/1.
Қол қойылған файлдар. Кері қайтару тізімінің, мөрдің және зәкірдің қол қойылған денесінде v бар, ал тізілім күнінің кіріс файлының өз v мәні бар.
Осы сайттағы қосылым мәртебесі: жұмыс істейді, бета немесе жоба.

Мәртебелер

Мәртебе	Мағынасы	Үйлесімсіз өзгеріске дейінгі хабарлама
Жұмыс істейді	Тұрақты. Оған сүйенуге арналған	Кемінде 12 ай
Бета	Жұмыс істейді және қолданылады, бірақ әлі өзгеруі мүмкін. Қол қойылған атрибуттар идентификаторлары уақытша тармақта тұрғанда, құрылғы протоколы мен дәлел файлдары бета болып қалады	Кемінде 30 күн, мүмкін болғанда; өзгерістер журналында не өзгергені айтылады
Жоба	Ұсыныс. Іздеу жүйелерінің индексіне кірмейді	Көзделмеген

Үйлесімсіз емес өзгерістер

Біз оларды ағымдағы нұсқада кез келген уақытта, хабарламасыз енгіземіз. Клиентіңіз оларға төзімді болуы тиіс:

жаңа операция, жаңа міндетті емес параметр, жауаптағы немесе қол қойылған денедегі жаңа өріс;
мәндер тізіміндегі жаңа мән, мысалы жаңа белгі, бас тарту себебі, оқиға атауы немесе қатенің code мәні;
ұзағырақ мәтін, жаңа тақырып, өрістердің басқа реті.

Сондықтан білмейтін өрістеріңізді елемеңіз, ал белгісіз мәнді қате емес, «басқа» деп қабылдаңыз. title немесе detail мәтіндеріне емес, code мәніне сүйеніңіз.

Үйлесімсіз өзгерістер

Бұл өзгерістер клиенттерді бұзады және тек жаңа негізгі нұсқада, ескісінің қасында шығады:

операцияны, параметрді немесе өрісті алып тастау не атын өзгерту;
өрістің мағынасын немесе түрін, сан пішімін өзгерту;
сұраудың жаңа міндетті параметрі немесе жаңа міндетті өрісі;
жарияланғаннан қатаңырақ шектеу;
басқа қолтаңба алгоритмі немесе қол қойылатын мәнді есептеудің басқа тәсілі.

Жаңа негізгі нұсқаның өз жолы (/v2) немесе өз schema мәні (tanba.pop/2) болады. Ескі нұсқа бүкіл хабарлама мерзімі бойы жұмыс істей береді.

Қолдаудан алу қалай өтеді

Операция немесе өріс анықтамалықта және OpenAPI файлында ескірген деп белгіленеді (deprecated: true), оның орнына не пайдалану керегі және жұмысын тоқтататын күні көрсетіледі.
Өзгерістер журналында сол күні жазба пайда болады.
Ескірген нәрсе сол күнге дейін жұмыс істейді. Хабарлама мерзімі кестедегі мәртебеден алынады және өзгерістер журналындағы жазбадан бастап есептеледі.
Сол күннен кейін ол алынып тасталады, ал өзгерістер журналы бұл туралы хабарлайды.

Қауіпсіздік пен заң себепті ерекшеліктер

Қауіпсіздік олқылығын жабатын немесе заң талап ететін өзгеріс бірден күшіне енуі мүмкін. Өзгерістер журналындағы жазбаны мүмкіндігінше тез жариялаймыз және сізге не істеу керегін айтамыз.

Қайдан қарау керек

Шарттың әр өзгерісі өзгерістер журналында, жаңалары жоғарыда, қарапайым сөздермен жазылған. Әр қосылым бетіндегі OpenAPI файлдары осы сайттың бастапқы көзі, сондықтан олар бойынша жасалған клиент әрдайым беттерге сәйкес келеді.