Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Eine Reihe von Richtlinien steuert den Daten-API-Generator im Zusammenhang mit unterbrechungsbedingten Änderungen, Benachrichtigungen, Versionen und Versionsverwaltung.
Versionsverwaltung und -versionen
Eine Version im Kontext des Daten-API-Generators bezieht sich auf jede veröffentlichte Version der Software, die durch das Major.Minor.Patch Format identifiziert wird. Diese Versionen sind in drei Kategorien unterteilt: stabil, durchbrechende Änderungen und Vorschau.
Verantwortung für Containerupdates
Der Daten-API-Generator-Container wird nicht automatisch aktualisiert. Kunden sind dafür verantwortlich, neue Versionen zu überwachen, ihre Wichtigkeit (einschließlich Sicherheitsupdates) zu bewerten und bereitgestellte Container entsprechend zu aktualisieren.
Der Container auf dem neuesten Stand zu halten, liegt in der Verantwortung des Kunden.
Stabile Versionen
Eine stabile Version des Daten-API-Generators ist abwärtskompatibel. Abwärtskompatibel bedeutet, dass jeder Von Ihnen geschriebene Code, der auf einer Version eines Daten-API-Generators basiert, eine neuere stabile Version übernehmen kann, ohne dass Codeänderungen erforderlich sind, um die Korrektheit oder vorhandene Funktionalität aufrechtzuerhalten.
Unterbrechen von Änderungsversionen
Eine bahnbrechende Änderungsversion des Daten-API-Generators ist nicht abwärtskompatibel. Die Einführung einer bahnbrechenden Änderungsversion in vorhandenem Clientcode erfordert möglicherweise Codeänderungen, um sicherzustellen, dass sich der Client genauso verhält wie bei der Zielbestimmung für die vorherige Version.
Aktuelle Änderungsversionen werden über den Artikel "Aktuelle Änderungsliste" und in der Änderungsbeschreibung einer GitHub-Version angekündigt. Die Veröffentlichung einer Vorschau-/Veröffentlichungskandidatenversion geht vor dem Unterbrechen von Änderungsversionen voraus, es sei denn, die Änderungen beheben kritische Sicherheits-, Datenschutz- oder rechtliche Probleme. Während frühere Versionen des Daten-API-Generators möglicherweise auf der GitHub-Versionsseite verfügbar bleiben, empfehlen wir, ein Upgrade auf die neueste Version durchzuführen, die Fehlerkorrekturen enthalten kann.
Vorschauversionen
Vorschauversionen des Daten-API-Generators werden mit dem X.Y.Z-rc Versionsverwaltungsschema identifiziert. Das -rc Suffix gibt an, dass der Build ein "Release candidate" ist. Vorschauversionen werden verwendet, um Feedback zu neuen Features und anderen Änderungen zu sammeln.
Sofern wir nicht beabsichtigen, wesentliche Änderungen von der letzten stabilen Version vorzunehmen, veröffentlichen wir die nächste Vorschauversion mit allem aus der neuesten stabilen Version und neuen Vorschaufeatures. Das nächste Daten-API-Generator-Update kann einige der neuen Vorschaufeatures unterbrechen, die zwischen Vorschauversionen hinzugefügt wurden. Dieses unterbrechende Verhalten bedeutet, dass Sie ihren Code möglicherweise ändern müssen, damit die Dinge wieder funktionieren.
Vorschauversionen sind nicht für einen langfristigen oder produktionsbezogenen Einsatz vorgesehen. Wenn eine neue stabile oder Vorschauversion verfügbar ist, sind ältere Vorschauversionen möglicherweise nicht mehr verfügbar. Es ist am besten, Vorschauversionen nur zu verwenden, wenn Sie aktiv an neuen Features arbeiten und bereit sind, bald nach der Veröffentlichung zu einer Nichtvorschauversion zu wechseln. Wenn einige Features aus einer Vorschauversion in einer neuen stabilen Version enthalten sind, werden die verbleibenden Vorschaufeatures einer neuen Vorschauversion hinzugefügt, die Sie ausprobieren können.
Versionsänderungstabelle
Von Bedeutung
Wir können eine wichtige Änderung an einer Neben- oder Patchversion einführen, wenn die Änderung wichtige Produktfehler, rechtliche, Sicherheits- oder Datenschutzbedenken behandelt.
| Veröffentlichungsart | Vorherige Version | Neue Version | Hinweise |
|---|---|---|---|
| Änderung unterbrechen | 1.Y.Z |
2.Y.Z |
Neue Features und Fehlerkorrekturen zusammen mit allen aktuellen Änderungen. |
| stabil | 1.1.Z |
1.2.Z |
Neue Features und Fehlerbehebungen ohne wesentliche Änderungen, es sei denn, die Änderungen betreffen wichtige Produktfehler, rechtliche, Sicherheits- oder Datenschutzbedenken. |
| stabil | 1.1.1 |
1.1.2 |
Fehlerkorrekturen ohne neue Features oder wesentliche Änderungen, es sei denn, die Änderungen betreffen wichtige Produktfehler, rechtliche, Sicherheits- oder Datenschutzbedenken. |
| Vorschau | X.Y.1-rc |
X.Y.2-rc |
Neue Vorschaufeatures und Fehlerbehebungen. (Wichtige Änderungen sind enthalten, wenn die Hauptversion gebrochen ist.) |
Einschneidende Änderungen
Um Die Sicherheit zu priorisieren, Features zu verbessern und die Codequalität aufrechtzuerhalten, können neue Versionen unserer Software zu schwerwiegenden Änderungen führen. Während wir uns bemühen, diese Änderungen durch sorgfältige Architekturentscheidungen zu minimieren, können sie dennoch auftreten. In solchen Fällen legen wir die Priorität fest, sie anzukündigen und mögliche Lösungen bereitzustellen.
Von Bedeutung
Wir können Änderungen ohne vorherige Ankündigung vornehmen, wenn die Änderung als nicht unterbrechend betrachtet wird oder wenn es sich um eine wesentliche Änderung handelt, um wichtige Produktfehler oder rechtliche, Sicherheits- oder Datenschutzbedenken zu beheben.
Was ist eine wichtige Änderung?
Eine bahnbrechende Änderung ist eine Änderung, die erfordert, dass Sie Ihre Anwendung aktualisieren, um Unterbrechungen zu verhindern. Im Daten-API-Generator können wesentliche Änderungen an REST-API-Verträgen, der GraphQL-Schemagenerierung und anderen Elementen umfassen, die sich auf Kompatibilität und Funktionalität auswirken.
Beispiele für bahnbrechende Änderungen
In den folgenden Beispielen handelt es sich um eine nichtexextive Liste der unterbrechungsfreien Änderungen am Daten-API-Generator:
- REST-API-Vertragsänderungen
- Änderungen bei der GraphQL-Schemagenerierung
- Änderungen, die sich auf Die Abwärtskompatibilität auswirken
- Entfernen oder Umbenennen von APIs oder Parametern
- Änderungen an Fehlercodes
- Anpassungen der Berechtigungsdefinitionsfunktionalität
- Entfernen zulässiger Parameter, Anforderungsfelder oder Antwortfelder
- Hinzufügen obligatorischer Parameter oder Anforderungsfelder ohne Standardwerte
- Änderungen an der vorgesehenen API-Endpunktfunktionalität
Definition einer geschützte Änderung
Eine ungebrochene Änderung bezieht sich auf eine Änderung, die ohne Unterbrechung in Ihre Anwendung integriert werden kann. Geschützte Änderungen werden in der Regel nach der Implementierung mitgeteilt. Ihre Anwendung sollte so konzipiert sein, dass diese Änderungen ohne vorherige Ankündigung behandelt werden.
Beispiele für nicht durchbrechliche Änderungen
Die folgenden Beispiele sind eine nichtexextive Liste nicht geschützter Änderungen am Daten-API-Generator:
- Einführung neuer Endpunkte
- Hinzufügen von Methoden zu vorhandenen Endpunkten
- Einbeziehung neuer Felder in Antworten und Anfragen
- Anpassungen der Feldreihenfolge innerhalb von Antworten
- Einführung optionaler Anforderungsheader
- Änderungen an Datenlänge und Antwortgröße
- Änderungen an Fehlermeldungen und Codes
- Korrekturen für HTTP-Antwortcodes
- Zusätzliche Metadaten in generierten OpenAPI-Dokumenten
Wie kommunizieren wir bruchbrechende Änderungen?
Wir legen eine Priorität fest, um Sie umgehend über änderungen zu informieren. In den Versionshinweisen zu Daten-API-Generator-Versionen auf GitHub und im dedizierten Artikel zur Änderungsliste finden Sie aktuelle Änderungsbenachrichtigungen.You can find breaking change notifications in the release notes of Data API builder releases on GitHub, and in the dedicated breaking changes list article.
Aktuelle Änderungsliste
In diesem Artikel werden die Änderungen und Die Einstellung von Features bekannt gegeben.
- Ab sofort gibt es keine unterbrechungsweisen Änderungen.