Update JSON URL-commands

fredlcore · Dec 1, 2024 · 6a90b08 · 6a90b08
1 parent 78208bd
commit 6a90b08
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 30 deletions.
diff --git a/docs/EN/using.md b/docs/EN/using.md
@@ -85,16 +85,19 @@ table th:nth-of-type(2) {
 
 ### JSON interface
 
+**For a complete structure of the JSON API, please see [here for the OpenAPI documentation](https://editor.swagger.io/?url=https://raw.githubusercontent.com/fredlcore/bsb_lan/master/openapi.yaml).**
+
 |URL command|Functionality|
 |:----------|:------------|
 |`/JQ=<x>,<y>,<z>`|Query parameters `<x>`, `<y>` and `<z>` and return a JSON structure|
 |`/JQ`      |Query parameters based on a received JSON structure via HTTP POST|  
-|`/JK=<x>`  |Query all parameters of category `<x>`|
-|`/JS`      |Set parameters based on a received JSON structure via HTTP
+|`/JS`      |Set parameters based on a received JSON structure via HTTP POST|
 |`/JR<x>`   |Query default value of parameter `<x>` and return a JSON structure|
-|`/JK=ALL`  |Dump ranges for all available categories as JSON structure|
-|`/JC=<x>,<y>,<z>`|Dump possible values for parameters `<x>`, `<y>` and `<z>` for option-type parameters. Same JSON structure as `/JK=<x>`.|
-|`/JB`      |Backup of all writeable parameters in a JSON structure that can be used to write back using `/JS`. |
+|`/JK=ALL`  |Dump parameter ranges for all available categories as JSON structure|
+|`/JK=<x>`  |Dump the parameter structure for all parameters of category `<x>`|
+|`/JC=<x>,<y>,<z>`|Dump the parameter structure for parameters `<x>`, `<y>` and `<z>`. Same JSON structure as `/JK=<x>`.|
+|`/JC       |Dump the parameter structure for a parameter list received as a JSON structure via HTTP POST.|
+|`/JB`      |Backup of all writeable parameters received as a JSON structure that can be used to restore using `/JS`.|
 |`/JB!<addr>`|Backup of all writeable parameters from controller at destination address `<addr>` in a JSON structure that can be used to write back using `/JS`. |
 |`/JL`      |Creates a JSON structure of BSB-LAN's configuration settings`|
 |`/JW`      |Writes configuration settings based on a JSON structure created by `/JL`|   

diff --git a/docs/de/using.md b/docs/de/using.md
@@ -82,20 +82,23 @@ URL-Befehle werden direkt nach dem Hostnamen von BSB-LAN und einem (optionalen)
 
 ### JSON-Schnittstelle
 
+**Für eine komplette Struktur der JSON API siehe [hier in der OpenAPI Dokumentation](https://editor.swagger.io/?url=https://raw.githubusercontent.com/fredlcore/bsb_lan/master/openapi.yaml).**
+
 | URL-Befehl | Funktionalität |
 |:----------|:------------|
-|`/JQ=<x>,<y>,<z>` | Abfragen der Parameter `<x>`, `<y>` und `<z>` und Zurückgeben einer JSON-Struktur |
-|`/JQ` | Abfragen von Parametern basierend auf einer empfangenen JSON-Struktur über HTTP POST |
-|`/JK=<x>` | Abfragen aller Parameter der Kategorie `<x>` |
-|`/JS` | Einstellen von Parametern basierend auf einer empfangenen JSON-Struktur über HTTP |
-|`/JR<x>` | Abfragen des Standardwerts des Parameters `<x>` und Zurückgeben einer JSON-Struktur |
-|`/JK=ALL` | Ausgeben der Bereiche für alle verfügbaren Kategorien als JSON-Struktur |
-|`/JC=<x>,<y>,<z>` | Ausgeben der möglichen Werte für die Parameter `<x>`, `<y>` und `<z>` für Parameter vom Typ Option. Gleiche JSON-Struktur wie `/JK=<x>`. |
-|`/JB` | Erstellen einer Sicherung aller beschreibbaren Parameter in einer JSON-Struktur, die zum Zurückschreiben mit `/JS` verwendet werden kann |
-|`/JL` | Erstellen einer JSON-Struktur der BSB-LAN-Konfigurationseinstellungen |
-|`/JW` | Schreiben der Konfigurationseinstellungen basierend auf einer JSON-Struktur, die mit `/JL` erstellt wurde |
-|`/JI` | Ausgeben von Laufzeitinformationen von BSB-LAN als JSON-Struktur |
-|`/JV` | Zurückgeben der Version der BSB-LAN-JSON-API als JSON-Struktur |
+|`/JQ=<x>,<y>,<z>`|Abfragen der Parameter `<x>`, `<y>` und `<z>` und Zurückgeben einer JSON-Struktur|
+|`/JQ`      |Abfragen von Parametern basierend auf einer empfangenen JSON-Struktur über HTTP POST|
+|`/JS`      |Einstellen von Parametern basierend auf einer empfangenen JSON-Struktur über HTTP POST|
+|`/JR<x>`   |Abfragen des Standardwerts des Parameters `<x>` und Zurückgeben einer JSON-Struktur|
+|`/JK=ALL`  |Ausgeben der Parameter-Bereiche für alle verfügbaren Kategorien als JSON-Struktur|
+|`/JK=<x>`  |Ausgeben der Parameterstruktur aller Parameter der Kategorie `<x>`|
+|`/JC=<x>,<y>,<z>`|Ausgeben der Parameterstruktur `<x>`, `<y>` und `<z>`. Gleiche JSON-Struktur wie `/JK=<x>`.|
+|`/JC       |Ausgeben der Parameterstruktur von einer über HTTP POST empfangenen Parameterliste. Gleiche JSON-Struktur wie `/JK=<x>`.|
+|`/JB`      |Erstellen einer Sicherung aller beschreibbaren Parameter in einer JSON-Struktur, die zum Zurückschreiben mit `/JS` verwendet werden kann|
+|`/JL`      |Erstellen einer JSON-Struktur der BSB-LAN-Konfigurationseinstellungen|
+|`/JW`      |Schreiben der Konfigurationseinstellungen basierend auf einer JSON-Struktur, die mit `/JL` erstellt wurde.|
+|`/JI`      |Ausgeben von Laufzeitinformationen von BSB-LAN als JSON-Struktur|
+|`/JV`      |Zurückgeben der Version der BSB-LAN-JSON-API als JSON-Struktur|
 
 ### Verschiedenes
 

diff --git a/docs/fr/using.md b/docs/fr/using.md
@@ -91,21 +91,24 @@ table th:nth-of-type(2) {
 
 ### Interface JSON
 
+**Pour une structure complète de l'API JSON, voir [ici dans la documentation OpenAPI](https://editor.swagger.io/?url=https://raw.githubusercontent.com/fredlcore/bsb_lan/master/openapi.yaml).**
+
 | Commande URL | Fonctionnalité |
 |:----------|:------------|
-| `/JQ=<x>,<y>,<z>` | Interroger les paramètres `<x>`, `<y>` et `<z>` et renvoyer une structure JSON |
-| `/JQ` | Interroger les paramètres en fonction d'une structure JSON reçue via HTTP POST |
-| `/JK=<x>` | Interroger tous les paramètres de la catégorie `<x>` |
-| `/JS` | Définir les paramètres en fonction d'une structure JSON reçue via HTTP |
-| `/JR<x>` | Interroger la valeur par défaut du paramètre `<x>` et renvoyer une structure JSON |
-| `/JK=ALL` | Afficher les plages de toutes les catégories disponibles en tant que structure JSON |
-| `/JC=<x>,<y>,<z>` | Afficher les valeurs possibles pour les paramètres `<x>`, `<y>` et `<z>` pour les paramètres de type option. Même structure JSON que `/JK=<x>`. |
-| `/JB` | Sauvegarder tous les paramètres modifiables dans une structure JSON qui peut être utilisée pour les réécrire avec `/JS` |
-| `/JB!<addr>` | Sauvegarder tous les paramètres modifiables du contrôleur à l'adresse de destination `<addr>` dans une structure JSON qui peut être utilisée pour les réécrire avec `/JS` |
-| `/JL` | Créer une structure JSON des paramètres de configuration de BSB-LAN |
-| `/JW` | Écrire les paramètres de configuration en fonction d'une structure JSON créée par `/JL` |
-| `/JI` | Afficher les informations d'exécution de BSB-LAN en tant que structure JSON |
-| `/JV` | Renvoyer la version de l'API JSON de BSB-LAN en tant que structure JSON |
+|`/JQ=<x>,<y>,<z>`|Interroger les paramètres `<x>`, `<y>` et `<z>` et renvoyer une structure JSON.|
+|`/JQ`      |Interroger les paramètres en fonction d'une structure JSON reçue via HTTP POST.|
+|`/JS`      |Définir les paramètres en fonction d'une structure JSON reçue via HTTP POST.|
+|`/JR<x>`   |Interroger la valeur par défaut du paramètre `<x>` et renvoyer une structure JSON.|
+|`/JK=ALL`  |Afficher les plages de toutes les catégories disponibles en tant que structure JSON.|
+|`/JK=<x>`  |Afficher la structure des paramètres pour tous les paramètres de la catégorie `<x>`.|
+|`/JC=<x>,<y>,<z>`|Afficher les valeurs possibles pour les paramètres `<x>`, `<y>` et `<z>` pour les paramètres de type option. Même structure JSON que `/JK=<x>`.|
+|`/JC      `|Afficher les valeurs possibles pour les paramètres en fonction d'une structure JSON reçue via HTTP POST. Même structure JSON que `/JK=<x>`.|
+|`/JB`      |Sauvegarder tous les paramètres modifiables dans une structure JSON qui peut être utilisée pour les réécrire avec `/JS` |
+|`/JB!<addr>`|Sauvegarder tous les paramètres modifiables du contrôleur à l'adresse de destination `<addr>` dans une structure JSON qui peut être utilisée pour les réécrire avec `/JS` |
+|`/JL`      |Créer une structure JSON des paramètres de configuration de BSB-LAN |
+|`/JW`      |Écrire les paramètres de configuration en fonction d'une structure JSON créée par `/JL` |
+|`/JI`      |Afficher les informations d'exécution de BSB-LAN en tant que structure JSON |
+|`/JV`      |Renvoyer la version de l'API JSON de BSB-LAN en tant que structure JSON |
 
 ### Divers