Dokumentation Änderungen am API

avonwyss

Mit dem Update zu V2 haben sich offenbar auch am bestehenden API Dinge geändert, habt ihr eine Übersicht der Änderungen damit ich den Client entsprechend nachführen kann und nicht auf trial-and-error angewiesen bin?

So wurde bisher z.B. bei den OrderItems die Properties created, createdBy, lastUpdated, lastupdatedBy zurückgegeben, neu aber nicht mehr...

Allgemein fehlt in der Doku die Angabe was die einzelnen Endpunkte effektiv zurückgeben, aber das hatte ich schon mal erwähnt.

mezzopiano

Hallo avonwyss
Die API ist immer noch Version 1, und das bleibt noch lange so, bis es mal einen Overhaul gibt. Also alle Parameter, die bisher gingen, sollten weiterhin gehen. Es gibt lediglich neue Properties, Parameter und Endpunkte.

OrderItem wurde geändert, weil es nun ein neues Pattern "ChildEntity" gibt, welches keine eigenen created/lastUpdated Properties hat, da es eigentlich keinen Sinn macht, dass sie eigene created/lastUpdated Properties haben, denn diese werden immer neu generiert mit der Order, und haben somit sowieso dieselbe created/lastUpdated Werte wie Order. Haben dort nicht bedacht, dass jemand per API diese ausliest.

Es gibt keine Übersicht über die Änderungen, denn das ist viel zu viel Aufwand, das zu tracken (über die ganze App hinweg). Wir haben uns aber grundsätzlich darum bemüht, dass alle API-Anfragen weiterhin so funktionieren wie vorher.

avonwyss

mezzopiano Danke für den Hinweis mit dem "ChildEntity". Wo wird dieses Pattern nebst den OrderItems noch angewendet?

Ich hatte die User-Information im "created" verwendet um bei gewissen automatisierten Operationen zu wissen ob die Items vom API erstellt wurden oder von einem Benutzer. So konnte ich nur den OrderItem ansehen um das zu wissen.

RaphaelCC

Hei @avonwyss wir werden das mit dem API Änderungen besser tracken in Zukunft. Das ist nicht gut gelaufen! Wir mussten feststellen, dass (was natürlich toll ist) CashCtrl mittlerweile so viele Nutzer:innen hat die zusammen alle Bereiche der Applikation beackern, dass es irgend eine zentrale Stelle braucht wo darüber geredet werden kann.
Vermutlich wie dein Beitrag hier, im Forum. Wir werden da proaktiver vorgehen das nächste mal, damit du und andere auch reagieren können.

Die Doku hat an manchen Stellen schon noch "Löcher" - das kann ich aber nie ganz ausschliessen. Aber auch undokumentierte, verfügbare Funktionen der API sollten sich nicht einfach so ändern.