Stabilität und Versionierung

Die Schnittstelle trägt die Versionsnummer 1. Sie steht in der OpenAPI-Datei im Feld info.version.

Was stabil bleibt

• Der Pfad einer Funktion und ihr Name ändern sich innerhalb einer Version nicht.
• Vorhandene Parameter behalten Name, Bedeutung und Typ.
• Felder in Antworten werden nicht entfernt und nicht umbenannt.
• Ein Fehlercode (zum Beispiel E-FEHLT) bedeutet immer dasselbe.

Was sich ändern darf

• Antworten können zusätzliche Felder erhalten. Lesen Sie deshalb nur die Felder, die Sie brauchen, und ignorieren Sie unbekannte.
• Funktionen können neue optionale Parameter erhalten.
• Neue Funktionen kommen hinzu.
• Texte von Meldungen können sich verbessern. Werten Sie Codes aus, nicht den Wortlaut.

Neue Version

Eine Änderung, die Pfade, Parameter oder Antworten unverträglich verändert, erscheint als neue Versionsnummer.

Abhängigkeiten

Die Referenz wird aus dem Quelltext erzeugt. Jede Funktion, die über /api/method erreichbar ist, steht darin, und die OpenAPI-Datei enthält dieselbe Liste.