Politika stabilnosti

REST API se verzionira u putanji. Trenutna verzija je v1, dostupna na https://api.optsens.com/api/v1.

Šta garantujemo u okviru v1

• Postojeća svojstva odgovora se ne uklanjaju i ne preimenuju.
• Postojeće putanje, parametri i autentifikacija se ne menjaju.
• Nova svojstva, novi endpointi i novi opcioni parametri mogu biti dodati u svakom trenutku. Pišite integraciju tako da ignoriše nepoznata svojstva.
• Enum vrednosti mogu dobiti nove članove (na primer novi action). Tretirajte enume kao otvorene skupove.

Promene koje prekidaju kompatibilnost

Promene koje ne mogu da se uvedu kompatibilno izlaze kao nova verzija na novoj putanji (/api/v2). Kada se to dogodi:

• v1 nastavlja da radi tokom objavljenog prelaznog perioda.
• Istorija izmena najavljuje novu verziju, korake migracije i datum gašenja, sa oznakom breaking.

Zastarevanje

Zastarela svojstva ili endpointi označavaju se u ovoj referenci i u istoriji izmena pre uklanjanja, a uklanjanja se dešavaju samo uz promenu verzije.