Referenzmaterialien

Materialien für die Arbeit mit einem Knoten unter Umgehung der Oberfläche und für den Abgleich von Begriffen: Referenzdokumente zur HTTP API und zur Einstellungsdatei, maschinenlesbare Schemas der Einstellungsdatei und ein Glossar der Begriffe, die im Handbuch und in der Oberfläche vorkommen.

Referenzdokumente und Schemas

Die Referenzdokumente beschreiben die HTTP API für Konfiguration und Daten, das Format der Einstellungsdatei sowie das Vorgehen beim Bearbeiten und Übertragen der Datei. Die Schemas sind eine maschinenlesbare Beschreibung der Einstellungsdatei im Format JSON Schema, in einer strengen und einer nachsichtigen Fassung. Die Dokumente sind auf Englisch verfasst und auf der Dokumentationswebsite veröffentlicht, mit einem Verzeichnis je Produktversion:

https://doc2.pstreamer.tv/reference/      vier Referenzdokumente
https://doc2.pstreamer.tv/schema/         zwei Schemas

Nehmen Sie das Verzeichnis der Version, die bei Ihnen installiert ist; gibt es dafür kein Verzeichnis, nehmen Sie das nächstältere. Die Referenz eines anderen Release beschreibt nicht Ihren Knoten. Was jedes Dokument enthält und wie man es verwendet, steht in Referenzdokumente; die Prüfung der Einstellungsdatei gegen das Schema in Prüfung mit dem JSON Schema.