Documents de référence

Documents permettant de travailler avec un nœud sans passer par l’interface et de vérifier les termes : documents de référence sur l’API HTTP et le fichier de configuration, schémas lisibles par machine du fichier de configuration et glossaire des termes rencontrés dans le manuel et dans l’interface.

Documents de référence et schémas

Les documents de référence décrivent l’API HTTP de configuration et de données, le format du fichier de configuration ainsi que la marche à suivre pour le modifier et le transporter. Les schémas sont une description lisible par machine du fichier de configuration au format JSON Schema, en version stricte et en version permissive. Les documents sont rédigés en anglais et publiés sur le site de la documentation, avec un répertoire par version du produit :

https://doc2.pstreamer.tv/reference/      quatre documents de référence
https://doc2.pstreamer.tv/schema/         deux schémas

Prenez le répertoire de la version installée chez vous ; s’il n’existe pas de répertoire pour elle, prenez le répertoire antérieur le plus proche. La référence d’une autre version ne décrit pas votre nœud. Le contenu de chaque document et la manière de s’en servir sont décrits dans Documents de référence ; la vérification du fichier de configuration à l’aide du schéma, dans Vérification avec le JSON Schema.