Änderungen von Dokument Schnittstellen

Zuletzt geändert von MACH ProForms GmbH am 10.12.2024

Von Version 99.1
bearbeitet von MACH ProForms GmbH
am 10.12.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 98.2
bearbeitet von MACH ProForms GmbH
am 10.12.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -24,9 +24,9 @@
24 24  
25 25  Grundsätzlich legen wir unsere APIs für eine möglichst lange Betriebsphase aus und streben Versionskompatibilität an. Im Nachfolgenden finden Sie unsere Vorgehensweise im Detail.
26 26  
27 -Wir behalten immer zwei Versionen online, soweit technisch möglich. Sobald eine neue Version hinzukommt, wird die älteste Version mit einem zeitlichen Horizont von mindestens 6 Monaten abgekündigt. Nach dieser Frist sind die veraltete Version und alle ihre Minor-Versionen nicht mehr erreichbar.
27 +Wir behalten (soweit technisch möglich) immer zwei Versionen online. Sobald eine neue Version hinzukommt, wird die älteste Version mit einem zeitlichen Horizont von mindestens 6 Monaten abgekündigt. Nach dieser Frist ist die Version und alle ihre Minor-Versionen nicht mehr erreichbar.
28 28  
29 -Eine neue **Major-Version (1.x)** kann Änderungen beinhalten, die nicht abwärtskompatibel sind. Dies sind z.B.:
29 +Eine neue **Major-Version (1.x)** kann Änderungen beinhalten, welche nicht mehr abwärtskompatibel sein müssen (Abhängig von Ihrer Implementierung). Dies sind z.B.:
30 30  
31 31  * Authentifizierungsmethoden
32 32  * Umbenennung und Löschung von Endpunkten
... ... @@ -34,7 +34,7 @@
34 34  * Umbenennung und Löschung von Parametern
35 35  * Restrukturierung des Response-Objekt
36 36  
37 -Eine neue **Minor-Version (x.1)** ist per Definition abwärtskompatibel zur **Major-Version**. Änderungen wären z.B.:
37 +Eine neue **Minor-Version (x.1)** ist per Definition abwärtskompatibel zur **Major-Version**. Dabei können sich aber folgende Dinge ändern:
38 38  
39 39  * Zusätzliche Endpunkte
40 40  * Zusätzliche HTTP-Methoden an Endpunkten
... ... @@ -43,4 +43,4 @@
43 43  
44 44  # Versionshistorie
45 45  
46 -Zu jeder unserer APIs finden Sie zukünftig jeweils einen untergeordneten "Release-Notes"-Artikel. Beispiel [[Submission-API: Release-Notes|doc:.01_SubmissionAPI.Release-Notes.WebHome]].
46 +Zu jeder API finden Sie als Unterknoten jeweils den "Release-Notes"-Artikel. Beispiel [[Submission-API|doc:.01_SubmissionAPI.Release-Notes.WebHome]].