opsi API documentation: Feedback wanted

[john]

Hello!

We are looking to gather some feedback on our new API documentation generated by opsi doc generator.
opsi doc generator generates documentation from source code. Have a look at the documentation.

We would greatly appreciate it if you provide us some feedback ranging from layout, to overall documentation.
Help us to improve our documentation!

Thanks for your time and interest.
Jeena

[GEI]

Seit einiger Weile gibt es auch eine schöne HTML-Doku.

super & danke!

Feedback erwünscht!

hmm, vielleicht pro Methode ein Beispiel mit opsi-admin ?

[n.wenselowski]

Ich hab das Topic mal aus dem ursprünglichen Thread rausgeworfen, damit man nicht so ewig danach suchen muss

Feedback erwünscht!

hmm, vielleicht pro Methode ein Beispiel mit opsi-admin ?

Sehe ich erstmal als am Ziel vorbei geschossen, weil es eine allgemeine Doku zur API sein soll und ich ungern im Code, aus welchem das generiert wird, noch Aufrufe für $externesTool unterbringen will.

Aber das heißt ja nicht, dass niemand so eine Seite anfangen kann

Gruß

Niko

[larsg]

Eine detailierte Beschreibung zu den Methoden und deren Input- und Outputwerten wäre hilfreich.
Welchen Typ haben die Parameter, welche Defaultwerte gibt es? Bei manchen Methoden ist das vorhanden, aber bei vielen wichtigen fehlt das.
Eine Beschreibung der jeweiligen Datenstruktur, die als Ergebnis rauskommt wäre auch von Nutzen. Da gibt es so einige verschiedene Varianten.
Ausserdem gibt es viele Methoden quasi doppelt, einige sind offenbar als veraltet gekennzeichnet und sollten nicht genutzt werden. Es wäre gut wenn das hier auch ersichtlich wäre.