FunktionenPreiseÜber unsArtikelDokumentation
Entwickler

API, SDK, MCP und Webhooks.

EntwicklerplattformSchnellstartAuthentifizierungAPI-ReferenzSDKMCPWebhooksFehlerPaginierungRatenbegrenzungenIdempotenzÄnderungsprotokollMigrations- und Versionierungsrichtlinie
Rohe API-DokumentationOpenAPI YAMLAsyncAPI YAML
  1. Startseite
  2. /
  3. Entwickler
  4. /
  5. Migrations- und Versionierungsrichtlinie

Migrations- und Versionierungsrichtlinie

Die öffentliche API bewahrt die Kompatibilität innerhalb von v1. Breaking Changes erfordern eine ausdrückliche Richtlinienprüfung, einen Changelog-Eintrag und einen Migrationspfad.

Kompatibilitätszusagen

  • Additive Felder und Endpunkte können innerhalb von v1 ausgeliefert werden.
  • Bestehende Antwortfelder ändern ihre Bedeutung innerhalb von v1 nicht.
  • Erforderliche Anfragefelder werden bestehenden v1-Schreibvorgängen nicht ohne einen Kompatibilitätsplan hinzugefügt.
  • Die SDK- und MCP-Oberflächen werden gegen dasselbe OpenAPI-Scope- und Operationsmodell geprüft.

Was das für Sie bedeutet

  • Tolerieren Sie neue, unbekannte Felder in Antworten (scheitern Sie nicht daran).
  • Pinnen Sie das SDK auf eine bekannte Version und führen Sie Upgrades bewusst durch.
  • Beobachten Sie den Changelog auf additive Änderungen.

Quellrichtlinie

Die Richtlinie für Breaking Changes wird unter docs/developer-platform/openapi-breaking-change-policy.md gepflegt und durch Vertragsprüfungen erzwungen.

StartseiteFunktionenPreiseÜber unsArtikelDokumentationEntwickler
© FabHubDatenschutz & CookiesNutzungsbedingungenBarrierefreiheit