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
opsi API documentation: Feedback wanted
opsi API documentation: Feedback wanted
opsi development - uib gmbh
Re: Methode für outdated Clients
super & danke!Seit einiger Weile gibt es auch eine schöne HTML-Doku.
hmm, vielleicht pro Methode ein Beispiel mit opsi-admin ?Feedback erwünscht!
Leibniz-Institut für Bildungsmedien | Georg-Eckert-Institut (GEI)
---
'opsi4instituts' = Communityprojekt für wissenschaftliche Einrichtungen
offenes Repository, Update-Notifier
wiki.o4i.org - www.gei.de/institut/direktion/it-service/opsi4instituts
---
'opsi4instituts' = Communityprojekt für wissenschaftliche Einrichtungen
offenes Repository, Update-Notifier
wiki.o4i.org - www.gei.de/institut/direktion/it-service/opsi4instituts
- n.wenselowski
- Ex-uib-Team
- Beiträge: 3194
- Registriert: 04 Apr 2013, 12:15
Re: opsi API documentation: Feedback wanted
Ich hab das Topic mal aus dem ursprünglichen Thread rausgeworfen, damit man nicht so ewig danach suchen muss
Aber das heißt ja nicht, dass niemand so eine Seite anfangen kann
Gruß
Niko
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.GEI hat geschrieben:hmm, vielleicht pro Methode ein Beispiel mit opsi-admin ?Feedback erwünscht!
Aber das heißt ja nicht, dass niemand so eine Seite anfangen kann
Gruß
Niko
Code: Alles auswählen
import OPSI
Re: opsi API documentation: Feedback wanted
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.
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.
Re: opsi API documentation: Feedback wanted
Die Dokumentation gibt einen guten Überblick über die Möglichkeiten. Vielen Dank.larsg hat geschrieben: ↑06 Sep 2020, 16:00 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.
Ich schliesse mich larsg an. Es wäre ebenfalls toll, wenn dann bei allen Funktionen eine Beschreibung steht, damit klar ist, wozu sie sind.