Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Sada zásad řídí tvůrce rozhraní Data API související se zásadními změnami, oznámeními, verzemi a správam verzí.
Správa verzí a vydané verze
A release in the context of Data API builder refers to every published version of the software, identified by the Major.Minor.Patch format. These releases fall into three categories: stable, breaking change, and preview.
Odpovědnost za aktualizaci kontejneru
Kontejner Tvůrce rozhraní Data API se neaktualizuje automaticky. Zákazníci zodpovídají za monitorování nových verzí, vyhodnocení jejich důležitosti (včetně aktualizací zabezpečení) a aktualizaci nasazených kontejnerů odpovídajícím způsobem.
Keeping the container up to date is the customer’s responsibility.
Stable releases
A stable version of Data API builder is backwards compatible. Zpětné kompatibility znamená, že jakýkoli kód, který napíšete, který spoléhá na jednu verzi tvůrce rozhraní Data API, může přijmout novější stabilní verzi, aniž by bylo nutné provádět změny kódu, aby se zachovala správnost nebo stávající funkce.
Vydání zásadních změn
Verze tvůrce rozhraní DATA API způsobující chybu není zpětně kompatibilní. Přijetí verze zásadní změny v existujícím klientském kódu může vyžadovat změny kódu, aby se zajistilo, že se klient chová přesně tak, jak tomu bylo při cílení na předchozí verzi.
Verze zásadních změn se oznamují prostřednictvím článku se seznamem zásadních změn a v popisu změn vydané verze GitHubu. Publikování verze Preview/release candidate předchází verzím zásadních změn, pokud změny neopravují důležité problémy se zabezpečením, ochranou osobních údajů nebo právními problémy. I když předchozí verze Tvůrce rozhraní DATA API můžou zůstat dostupné na stránce vydaných verzí GitHubu, doporučujeme upgradovat na nejnovější verzi, která může zahrnovat opravy chyb.
Preview releases
Verze Preview pro Tvůrce rozhraní Data API jsou identifikovány schématem X.Y.Z-rc správy verzí. Přípona -rc označuje, že sestavení je "release candidate". Verze Preview slouží ke shromažďování názorů na nové funkce a další změny.
Pokud neplánujeme účelně provádět významné změny z poslední stabilní verze, publikujeme další verzi Preview se vším od nejnovější stabilní verze a nových funkcí ve verzi Preview. Další aktualizace Tvůrce rozhraní Data API může narušit některé z nových funkcí preview, které jsme přidali mezi verzemi Preview. Toto chování způsobující chybu znamená, že možná budete muset změnit kód, aby všechno fungovalo znovu.
Verze Preview nejsou určené pro dlouhodobé ani produkční použití. Jakmile bude k dispozici nová stabilní verze nebo verze Preview, starší verze Preview už nemusí být přístupné. Nejlepší je používat verze Preview jenom v době, kdy aktivně pracujete na nových funkcích a jste připraveni přejít na verzi, která není ve verzi Preview. Pokud jsou některé funkce z verze Preview součástí nové stabilní verze, zbývající funkce ve verzi Preview se přidají do nové verze Preview, kterou si můžete vyzkoušet.
Tabulka změn verzí
Important
Při řešení kritických chyb produktu, právních, bezpečnostních nebo ochrany osobních údajů můžeme zavést zásadní změnu v podverzi nebo vydání opravy.
| Release type | Previous Version | New Version | Notes |
|---|---|---|---|
| Breaking Change | 1.Y.Z |
2.Y.Z |
Nové funkce a opravy chyb spolu se všemi zásadními změnami |
| Stable | 1.1.Z |
1.2.Z |
Nové funkce a opravy chyb bez zásadních změn, pokud změny nevyřeší kritické chyby produktu, právní problémy, zabezpečení nebo ochranu osobních údajů. |
| Stable | 1.1.1 |
1.1.2 |
Opravy chyb bez nových funkcí nebo zásadních změn, pokud změny neobsahují kritické chyby produktu, právní, bezpečnostní nebo ochranu osobních údajů. |
| Preview | X.Y.1-rc |
X.Y.2-rc |
Nové funkce a opravy chyb ve verzi Preview (Zásadní změny se zahrnou, pokud dojde k zvýšení hlavní verze.) |
Breaking Changes
Aby bylo možné určit prioritu zabezpečení, vylepšit funkce a zachovat kvalitu kódu, můžou nové verze našeho softwaru zahrnovat zásadní změny. I když se snažíme tyto změny minimalizovat prostřednictvím pečlivé volby architektury, můžou k nim stále docházet. V takových případech je prioritou oznámit je a poskytovat možná řešení.
Important
Změny můžeme provádět bez předchozího upozornění, pokud je změna považována za neprolomenou nebo pokud se jedná o zásadní změnu, která řeší kritické chyby produktů nebo právní, zabezpečení nebo obavy ohledně ochrany osobních údajů.
Co je zásadní změna?
Zásadní změna je úprava, která vyžaduje aktualizaci aplikace, aby se zabránilo přerušení. V Tvůrci rozhraní Data API můžou zásadní změny zahrnovat změny kontraktů rozhraní REST API, generování schématu GraphQL a další prvky, které ovlivňují kompatibilitu a funkčnost.
Příklady zásadních změn
The following examples are a nonexhaustive list of breaking changes to Data API builder:
- Úpravy kontraktů rozhraní REST API
- Změny ve generování schématu GraphQL
- Změny ovlivňující zpětnou kompatibilitu
- Odebrání nebo přejmenování rozhraní API nebo parametrů
- Změny kódů chyb
- Úpravy funkcí definice oprávnění
- Odebrání povolených parametrů, polí požadavků nebo polí odpovědi
- Přidání povinných parametrů nebo polí požadavku bez výchozích hodnot
- Úpravy zamýšlených funkcí koncového bodu rozhraní API
Definice neprolomné změny
A non-breaking change refers to a change that can be integrated into your application without causing disruption. Změny, které se nerozrušují, se obvykle předávají po implementaci. Vaše aplikace by měla být navržená tak, aby tyto změny zpracovávala bez předchozího upozornění.
Příklady nerušných změn
The following examples are a nonexhaustive list of nonbreaking changes to Data API builder:
- Úvod do nových koncových bodů
- Přidání metod do existujících koncových bodů
- Začlenění nových polí do odpovědí a žádostí
- Úpravy pořadí polí v odpovědích
- Úvod do volitelných hlaviček požadavků
- Změny délky dat a velikosti odpovědi
- Změny chybových zpráv a kódů
- Opravy kódů odpovědí HTTP
- Další metadata ve vygenerovaných dokumentech OpenAPI
Jak komunikujeme s zásadními změnami?
Upřednostňujeme, abychom vás neprodleně informovali o zásadních změnách. Oznámení o zásadních změnách najdete v poznámkách k verzi vydaných verzí tvůrce rozhraní Data API na GitHubu.
Aktuální seznam zásadních změn
V tomto článku jsou oznámeny zásadní změny a vyřazení funkcí.
- Odteď neexistují žádné zásadní změny.