diff --git a/doc/fr/references/admin_api.md b/doc/fr/references/admin_api.md index e602d52..e412c5a 100644 --- a/doc/fr/references/admin_api.md +++ b/doc/fr/references/admin_api.md @@ -22,9 +22,8 @@ Où: - `""` est une chaîne de caractère arbitraire ayant pour objectif d'identifier de manière unique l'utilisateur associé au jeton; - `""` peut prendre une des deux valeurs `reader` ou `writer` correspondant aux droits suivants respectifs: - - droit en lecture sur l'ensemble des entités (proxy, layer); - - droit en lecture ET en écriture sur l'ensemble des entités. - + - droit en lecture sur l'ensemble des entités (proxy, layer); + - droit en lecture ET en écriture sur l'ensemble des entités. ## Points d'entrée @@ -34,29 +33,29 @@ Créer un nouveau proxy #### Exemple de corps de requête -```json5 +```json { - "name": "myproxy", // OBLIGATOIRE - Nom du proxy - "to": "https://www.cadoles.com", // OBLIGATOIRE - Site distant ciblé par le proxy - "from": ["*"] // OPTIONNEL - Liste de patrons de filtrage associés au proxy + "name": "myproxy", // OBLIGATOIRE - Nom du proxy + "to": "https://www.cadoles.com", // OBLIGATOIRE - Site distant ciblé par le proxy + "from": ["*"] // OPTIONNEL - Liste de patrons de filtrage associés au proxy } ``` #### Exemple de résultat -```json5 +```json { - "data": { - "proxy": { - "name": "myproxy", - "weight": 0, - "enabled": false, - "to": "https://www.cadoles.com", - "from": ["*"], - "createdAt": "2018-12-10T13:45:00.000Z", - "updatedAt": "2018-12-10T13:45:00.000Z" - } + "data": { + "proxy": { + "name": "myproxy", + "weight": 0, + "enabled": false, + "to": "https://www.cadoles.com", + "from": ["*"], + "createdAt": "2018-12-10T13:45:00.000Z", + "updatedAt": "2018-12-10T13:45:00.000Z" } + } } ``` @@ -74,19 +73,19 @@ Récupérer les informations complètes sur un proxy #### Exemple de résultat -```json5 +```json { - "data": { - "proxy": { - "name": "myproxy", - "weight": 0, - "enabled": false, - "to": "https://www.cadoles.com", - "from": ["*"], - "createdAt": "2018-12-10T13:45:00.000Z", - "updatedAt": "2018-12-10T13:45:00.000Z" - } + "data": { + "proxy": { + "name": "myproxy", + "weight": 0, + "enabled": false, + "to": "https://www.cadoles.com", + "from": ["*"], + "createdAt": "2018-12-10T13:45:00.000Z", + "updatedAt": "2018-12-10T13:45:00.000Z" } + } } ``` @@ -100,30 +99,30 @@ Modifier un proxy #### Exemple de corps de requête -```json5 +```json { - "to": "https://www.cadoles.com", // OPTIONNEL - Site distant ciblé par le proxy + "to": "https://www.cadoles.com", // OPTIONNEL - Site distant ciblé par le proxy "from": ["mylocalproxydomain:*"], // OPTIONNEL - Liste de patrons de filtrage associés au proxy - "weight": 100, // OPTIONNEL - Poids à associer au proxy - "enabled": true, // OPTIONNEL - Activer/désactiver le proxy + "weight": 100, // OPTIONNEL - Poids à associer au proxy + "enabled": true // OPTIONNEL - Activer/désactiver le proxy } ``` #### Exemple de résultat -```json5 +```json { - "data": { - "proxy": { - "name": "myproxy", - "weight": 100, - "enabled": true, - "to": "https://www.cadoles.com", - "from": ["mylocalproxydomain:*"], - "createdAt": "2018-12-10T13:45:00.000Z", - "updatedAt": "2020-10-02T15:09:00.000Z" - } + "data": { + "proxy": { + "name": "myproxy", + "weight": 100, + "enabled": true, + "to": "https://www.cadoles.com", + "from": ["mylocalproxydomain:*"], + "createdAt": "2018-12-10T13:45:00.000Z", + "updatedAt": "2020-10-02T15:09:00.000Z" } + } } ``` @@ -141,17 +140,17 @@ Lister les proxies existants #### Exemple de résultat -```json5 +```json { - "data": { - "proxies": [ - { - "name": "myproxy", - "weight": 0, - "enabled": false, - } - ] - } + "data": { + "proxies": [ + { + "name": "myproxy", + "weight": 0, + "enabled": false + } + ] + } } ``` @@ -169,11 +168,11 @@ Supprimer le proxy #### Exemple de résultat -```json5 +```json { - "data": { - "proxyName": "myproxy" - } + "data": { + "proxyName": "myproxy" + } } ```