REST API Dokumentation

Hallo,

die REST API ist ja schön und gut, aber die Dokumentation dazu mehr als mangelhaft.
Gibt es denn irgendwo eine ausführliche Doku - besonders für die verschiedenen Action Befehle.

Hallo erstmal,

hast du dir unter “http://DeineMobyDickIp/services” die Rest-Anfragen schon angeschaut, dort findest du auch einige Beispiele bzw. kannst die Anfragen live testen.

Gruß
Markus

Ich sitze gerade vor dem gleichen Problem. Gerade bei den actions steht oft nur ein Beispiel. Gibt es dafür keine komplette Liste. Das ist doch eigentlich eine Kleinigkeit.

Oder hier als anderes Beispiel:

/identity/{userName} Change one or more database fields

Dazu gibt es kein Beispiel, was kann ich damit machen?

Ich habe vieles auch nur durch Trial und Error herausgefunden und aus der Asterisk-Dokumentation abgeleitet. Ich bin ebenfalls für eine umfangreichere REST-Dokumentation.

Um dieses Thema zu pushen…
ich würde mich auch über eine umfangreichere REST Doku freuen.

Die Beispiele sind schön und gut, jedoch wäre eine Auflistung aller möglichen Parameter schon hilfreich.

Hilfreich ist noch nett formuliert. Wir entwickeln ebenfalls Software und unsere Schnittstellen sind komplett dokumentiert. Ohne Doku ist eine Schnittstelle nichts wert

Ja, die Doku ist lückenhaft und wir werden das zeitnah verbessern.

Ich arbeite gerade an einem Python-Modul für die API-Anbindung. Einige Wünsche zum API habe ich schon hier Feature Request: REST API - Lables hinterlassen. Was die Doku betrifft fehlt mir folgendes unter “http://DeineMobyDickIp/services ”:

  • “Example Value / Model” ist stets leer
  • Informationen über Feldlängen und gültige Inhalte
  • Welche Felder eindeutig sein müssen und wie viele Zeichen dabei berücksichtigt werden

Solche Dinge muss ich im Moment durch try and error herausfinden. Ein schönes Beispiel ist der Displayname im Telefonbuch. Der muss eindeutig sein allerdings ganz offensichtlich innerhalb der ersten N Zeichen, wie viele das sind konnte ich bis jetzt nicht herausfinden. Warum der Displayname eindeutig sein muss bleibt mir auch ein Rätsel :slight_smile: