Stabilität und Änderungen

Die Spec ist der Vertrag zwischen deiner Software und Shirtee. Wir entwickeln sie additiv weiter.

Das darfst du erwarten

• Neue Endpunkte, neue Felder in Antworten und neue optionale Parameter können jederzeit erscheinen.
• Bestehende Felder, Pfade und Antwortcodes ändern wir nicht still. Eine Änderung, die bestehende Integrationen brechen könnte, kommt zuerst auf einem neuen Pfad. Der alte Pfad bleibt, bis die Umstellung angekündigt und abgeschlossen ist.
• Was sich geändert hat, steht im Änderungsprotokoll.

So sicherst du dich ab

• Ignoriere unbekannte Felder in Antworten. Ein neues Feld darf deine Software nicht zum Absturz bringen.
• Werte extra.error aus, nicht detail. Die Meldungstexte können sich ändern, die Codes bleiben.
• Lies Enum-Werte tolerant. Eine Liste von Statuswerten kann um neue Werte wachsen. Behandle unbekannte Werte als „weiter beobachten“, nicht als Fehler.
• Pinne nichts auf Reihenfolge. Die Reihenfolge von Feldern in JSON ist nicht festgelegt.