Skip to main content
Wir veröffentlichen regelmäßig Aktualisierungen unserer Dokumentation, und die Übersetzung dieser Seite ist möglicherweise noch nicht abgeschlossen. Aktuelle Informationen findest du in der englischsprachigen Dokumentation.

Aktuelle Änderungen

Erfahre mehr über die Breaking Changes, die in jeder REST-API-Version vorgenommen wurden.

Informationen zu Breaking Changes in der REST-API

Die GitHub Enterprise Cloud-REST-API ist versionsspezifisch. Der API-Versionsname basiert auf dem Datum, an dem die API-Version veröffentlicht wurde. Beispielsweise wurde die API-Version 2022-11-28 am Mon, 28 Nov 2022 veröffentlicht.

Alle Breaking Changes werden in einer neuen API-Version veröffentlicht. Breaking Changes sind Änderungen, die möglicherweise eine Integration unterbrechen können. Zu Breaking Changes gehören:

  • Entfernen eines gesamten Vorgangs
  • Entfernen oder Umbenennen eines Parameters
  • Entfernen oder Umbenennen eines Antwortfelds
  • Hinzufügen eines neuen erforderlichen Parameters
  • Erforderlichmachen eines zuvor optionalen Parameters
  • Ändern des Typs eines Parameters oder Antwortfelds
  • Entfernen von Enumerationswerten
  • Hinzufügen einer neuen Validierungsregel zu einem vorhandenen Parameter
  • Ändern der Authentifizierungs- oder Autorisierungsanforderungen

Alle additiven (Nonbreaking) Changes sind in allen unterstützten API-Versionen verfügbar. Additive Änderungen sind Änderungen, die eine Integration nicht unterbrechen sollten. Zu den additiven Änderungen gehören:

  • Hinzufügen eines Vorgangs
  • Hinzufügen eines optionalen Parameters
  • Hinzufügen eines optionalen Anforderungsheaders
  • Hinzufügen eines Antwortfelds
  • Hinzufügen eines Antwortheaders
  • Hinzufügen von Enumerationswerten

Wenn eine neue REST-API-Version veröffentlicht wird, wird die vorherige API-Version noch mindestens 24 Monate nach der Veröffentlichung der neuen API-Version unterstützt.

Weitere Informationen zu API-Versionen findest du unter API-Versionen.

Upgrade auf eine neue API-Version

Bevor du ein Upgrade auf eine neue REST-API-Version durchführst, solltest du den Abschnitt auf dieser Seite lesen, der der neuen API-Version entspricht, um zu verstehen, welche Breaking Changes enthalten sind und um weitere Informationen über das Upgrade auf diese API-Version zu erhalten.

Wenn du deine Integration aktualisierst, um die neue API-Version im Header X-GitHub-Api-Version anzugeben, musst du auch alle erforderlichen Änderungen vornehmen, damit deine Integration mit der neuen API-Version funktioniert.

Sobald deine Integration aktualisiert ist, teste sie, um zu überprüfen, ob sie mit der neuen API-Version funktioniert.

Breaking Changes für 2022-11-28

Version 2022-11-28 ist die erste Version der GitHub Enterprise Cloud-REST-API, nachdem die datumsbasierte Versionsverwaltung eingeführt wurde. Diese Version enthält keine Breaking Changes.