Thema: [✔] Pflegezustand API-Doku

Hallo zusammen,

ich wünsche mir zu Weihnachten eine Verbesserung des Pflegezustandes Eurer API-Doku.

2 Beispiele:

Filterung nach State hier im Forum am 06.05.2017 beschrieben, in der Doku nicht

In meinem eigenen Code habe ich jetzt gefunden:

PHP-Code:

'fn': 'container'
'sub': 'myfolderv2' 


"Hm, das haben die ollen Hansels wohl auch nicht dokumentiert ..." FALSCH! Das ist aus der alten PDF-Doku, inzwischen kann man dafür fn=group mit group=0 verwenden. Group erlaubt aber kein Filtern nach Status, myfolderv2 schon ...

Merkt Ihr, wie unübersichtlich das wird? ;-)

Jetzt könnte man sagen, "Solange es läuft ..." - aber wenn mal etwas nicht läuft, sucht man sich tot, weil man Funktionen an mindestens drei Stellen (PDF, Eure Seite und hier) suchen muß - geht Euch das nicht genauso?

Ich weiß ja zunächst nicht, ob ich einen Fehler in der Implementierung gemacht habe, bei Euch etwas krumm läuft oder Ihr eine alte Funktion gekickt / geändert habt ...

Ich kann auf der anderen Seite nur reagieren, indem ich in meinem eigenen Code die genauen Fundstellen für die Funktionen dokumentiere, damit ich irgendwann später auch mal ein vernünftiges Troubleshooting machen kann.

An der Stelle könnt Ihr den Support wirklich verbessern, hier also meine Wunschliste für Weihnachten (Zusage genügt, Timeline ist verhandelbar :->)

1. Liste aller nutzbaren Funktionen und Parameter an einem Ort
2. Zusatzinfos (ist eine Funktion deprecated? Wird sie z.B. mit Release X ca. im Sommer 2018 deaktiviert? Muß ich handeln / ein Refactoring planen?)

Ich glaube, auf lange Sicht leben wir so alle etwas besser - Amen

Cannonau

Zitat von Nuka

Der Wihnachtsmann hat doch schon andere Wünsche von dir auf seinem Zettel?

Zuviel Glühwein abbekommen? ))) alter Säufer xD

Erwischt!

Es hat doch auch niemand gesagt, daß nur einer erlaubt ist. Ihr wählt ja aus, was Ihr erfüllen wollt und könnt.

Ich gebe ja zu, daß Eure Doku im Vergleich zu anderen schon sehr gut ist. Woanders bleiben Fehler jahrelang unkorrigiert oder es werden Details unterschlagen, die eine Nutzung der API vollständig verhindern, wenn man nicht kreativ ist und um die Ecke denkt - Kontaktmöglichkeiten gibt es auch oft keine.

Ich sehe aber auch, daß Eure API immer komplexer wird, da ist eine blitzsaubere Doku echt Trumpf, auch für Euch. Je Doku desto Relax

Cannonau