Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of de directory te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen de mappen te wijzigen.
Een set beleidsregels bepaalt de opbouwfunctie voor gegevens-API's met betrekking tot belangrijke wijzigingen, meldingen, releases en versiebeheer.
Versiebeheer en releases
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.
Verantwoordelijkheid voor containerupdate
De Data API Builder-container wordt niet automatisch bijgewerkt. Klanten zijn verantwoordelijk voor het bewaken van nieuwe releases, het evalueren van hun belang (inclusief beveiligingsupdates) en het bijwerken van geïmplementeerde containers dienovereenkomstig.
Keeping the container up to date is the customer’s responsibility.
Stable releases
A stable version of Data API builder is backwards compatible. Achterwaarts compatibel impliceert dat elke code die u schrijft die afhankelijk is van één versie van een Data API-opbouwfunctie een nieuwere stabielere versie kan aannemen zonder dat codewijzigingen nodig zijn om de juistheid of bestaande functionaliteit te behouden.
Belangrijke wijzigingsreleases
Een belangrijke wijzigingsversie van Data API Builder is niet compatibel met eerdere versies. Als u een wijzigingsversie die fouten maakt in de bestaande clientcode, zijn mogelijk codewijzigingen vereist om ervoor te zorgen dat de client zich precies gedraagt als bij het toepassen van de vorige versie.
Wijzigingsversies die fouten veroorzaken, worden aangekondigd via het artikel over de wijzigingslijst die fouten veroorzaken en in de beschrijving van de wijziging in een GitHub-release. Publicatie van een preview-/releasekandidaatversie gaat vooraf aan belangrijke wijzigingsversies, tenzij de wijzigingen kritieke beveiligings-, privacy- of juridische problemen oplossen. Hoewel eerdere versies van Data API Builder mogelijk beschikbaar blijven op de gitHub-releasespagina, wordt u aangeraden een upgrade uit te voeren naar de nieuwste versie, waaronder mogelijk bugfixes.
Preview releases
Preview-versies van Data API Builder worden geïdentificeerd met het X.Y.Z-rc versiebeheerschema. Het -rc achtervoegsel geeft aan dat de build een 'releasekandidaat' is. Preview-versies worden gebruikt om feedback te verzamelen over nieuwe functies en andere wijzigingen.
Tenzij we van plan zijn belangrijke wijzigingen aan te brengen ten opzichte van de laatste stabiele versie, publiceren we de volgende preview-versie met alles, van de nieuwste stabiele release en nieuwe preview-functies. De volgende update voor data-API builder kan enkele van de nieuwe preview-functies die we hebben toegevoegd tussen preview-versies verbreken. Dit foutgedrag betekent dat u mogelijk uw code moet wijzigen om de zaken opnieuw te laten werken.
Preview-versies zijn niet bedoeld voor langdurig gebruik of productiegebruik. Wanneer een nieuwe stabiele of preview-versie beschikbaar wordt, zijn oudere preview-versies mogelijk niet meer toegankelijk. Het is raadzaam om alleen preview-versies te gebruiken wanneer u actief aan nieuwe functies werkt en klaar bent om snel na de release over te schakelen naar een niet-preview-versie. Als sommige functies van een preview-versie zijn opgenomen in een nieuwe stabiele versie, worden de resterende preview-functies toegevoegd aan een nieuwe preview-versie om uit te proberen.
Versiewijzigingstabel
Important
We kunnen een belangrijke wijziging introduceren in een kleine of patchrelease wanneer de wijziging betrekking heeft op kritieke productfouten, juridische, beveiligings- of privacyproblemen.
| Release type | Previous Version | New Version | Notes |
|---|---|---|---|
| Breaking Change | 1.Y.Z |
2.Y.Z |
Nieuwe functies en bugfixes, samen met eventuele belangrijke wijzigingen. |
| Stable | 1.1.Z |
1.2.Z |
Nieuwe functies en oplossingen voor fouten zonder wijzigingen die fouten veroorzaken, tenzij de wijzigingen betrekking hebben op kritieke productfouten, juridische, beveiligings- of privacyproblemen. |
| Stable | 1.1.1 |
1.1.2 |
Oplossingen voor fouten zonder nieuwe functies of wijzigingen die fouten veroorzaken, tenzij de wijzigingen betrekking hebben op kritieke productfouten, juridische, beveiligings- of privacyproblemen. |
| Preview | X.Y.1-rc |
X.Y.2-rc |
Nieuwe preview-functies en bugfixes. (Belangrijke wijzigingen worden opgenomen als de primaire versie wordt gestoten.) |
Breaking Changes
Om prioriteit te geven aan beveiliging, functies te verbeteren en codekwaliteit te behouden, kunnen nieuwe versies van onze software belangrijke wijzigingen bevatten. Hoewel we ernaar streven om deze wijzigingen te minimaliseren door zorgvuldige architectuurkeuzen, kunnen ze nog steeds optreden. In dergelijke gevallen maken we het een prioriteit om ze aan te kondigen en mogelijke oplossingen te bieden.
Important
We kunnen wijzigingen aanbrengen zonder voorafgaande kennisgeving als de wijziging wordt beschouwd als niet-brekend, of als het een belangrijke wijziging is die wordt aangebracht om kritieke productfouten of juridische, beveiligings- of privacyproblemen aan te pakken.
Wat is een wijziging die fouten veroorzaakt?
Een wijziging die fouten veroorzaken, is een wijziging die vereist dat u uw toepassing bijwerkt om onderbrekingen te voorkomen. In data-API builder kunnen wijzigingen die fouten veroorzaken, wijzigingen in REST API-contracten, het genereren van GraphQL-schema's en andere elementen die van invloed zijn op de compatibiliteit en functionaliteit, omvatten.
Voorbeelden van belangrijke wijzigingen
The following examples are a nonexhaustive list of breaking changes to Data API builder:
- Wijzigingen van REST API-contracten
- Wijzigingen in graphQL-schemageneratie
- Wijzigingen die van invloed zijn op compatibiliteit met eerdere versies
- Api's of parameters verwijderen of de naam ervan wijzigen
- Wijzigingen in foutcodes
- Aanpassingen aan de functionaliteit van de machtigingsdefinitie
- Toegestane parameters, aanvraagvelden of antwoordvelden verwijderen
- Toevoeging van verplichte parameters of aanvraagvelden zonder standaardwaarden
- Wijzigingen in de beoogde API-eindpuntfunctionaliteit
Definitie van een vaste wijziging
A non-breaking change refers to a change that can be integrated into your application without causing disruption. Niet-brekende wijzigingen worden doorgaans na de implementatie gecommuniceerd. Uw toepassing moet zijn ontworpen voor het afhandelen van deze wijzigingen zonder voorafgaande kennisgeving.
Voorbeelden van niet-belangrijke wijzigingen
The following examples are a nonexhaustive list of nonbreaking changes to Data API builder:
- Introductie van nieuwe eindpunten
- Toevoeging van methoden aan bestaande eindpunten
- Integratie van nieuwe velden in antwoorden en aanvragen
- Aanpassingen aan veldvolgorde binnen antwoorden
- Introductie van optionele aanvraagheaders
- Wijzigingen in gegevenslengte en antwoordgrootte
- Wijzigingen in foutberichten en codes
- Oplossingen voor HTTP-antwoordcodes
- Extra metagegevens in gegenereerde OpenAPI-documenten
Hoe communiceren we belangrijke wijzigingen?
We maken het een prioriteit om u onmiddellijk te informeren over wijzigingen die fouten veroorzaken. U vindt belangrijke wijzigingsmeldingen in de releaseopmerkingen van Data API Builder-releases op GitHub.
Lijst met huidige wijzigingen die fouten veroorzaken
Belangrijke wijzigingen en buitengebruikstelling van functies worden aangekondigd in dit artikel.
- Vanaf nu zijn er geen wijzigingen die fouten veroorzaken