opsi API documentation: Feedback wanted

The place for development of / with / for opsi.
Post your API questions here!
Antworten
Benutzeravatar
john
uib-Team
Beiträge: 1
Registriert: 24 Jun 2019, 10:40

opsi API documentation: Feedback wanted

Beitrag von 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
opsi development - uib gmbh
Benutzeravatar
GEI
Beiträge: 226
Registriert: 12 Feb 2010, 13:00
Wohnort: Braunschweig
Kontaktdaten:

Re: Methode für outdated Clients

Beitrag von 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 ? :roll:
Georg-Eckert-Institut - Leibniz-Institut für internationale Schulbuchforschung (GEI)
---
'opsi4instituts' = Communityprojekt für wissenschaftliche Einrichtungen
offenes Repository, Update-Notifier
http://www.gei.de/o4i - https://wiki.o4i.org
Benutzeravatar
n.wenselowski
Ex-uib-Team
Beiträge: 3195
Registriert: 04 Apr 2013, 12:15

Re: opsi API documentation: Feedback wanted

Beitrag von n.wenselowski »

Ich hab das Topic mal aus dem ursprünglichen Thread rausgeworfen, damit man nicht so ewig danach suchen muss ;)
GEI hat geschrieben:
Feedback erwünscht!
hmm, vielleicht pro Methode ein Beispiel mit opsi-admin ? :roll:
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

Code: Alles auswählen

import OPSI
larsg
Beiträge: 274
Registriert: 16 Dez 2014, 18:06

Re: opsi API documentation: Feedback wanted

Beitrag von 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.
ftsystems
Beiträge: 1
Registriert: 21 Aug 2021, 22:39
Wohnort: CH-Winterthur
Kontaktdaten:

Re: opsi API documentation: Feedback wanted

Beitrag von ftsystems »

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.
Die Dokumentation gibt einen guten Überblick über die Möglichkeiten. Vielen Dank.
Ich schliesse mich larsg an. Es wäre ebenfalls toll, wenn dann bei allen Funktionen eine Beschreibung steht, damit klar ist, wozu sie sind.
Antworten