doc: enable json highlighting in reference examples
Cadoles/bouncer/pipeline/head This commit looks good Details

This commit is contained in:
wpetit 2024-03-29 09:36:36 +01:00
parent 274bef13d8
commit 3a894972f1
1 changed files with 57 additions and 58 deletions

View File

@ -25,7 +25,6 @@ Où:
- droit en lecture sur l'ensemble des entités (proxy, layer); - 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 ET en écriture sur l'ensemble des entités.
## Points d'entrée ## Points d'entrée
### `POST /api/v1/proxies` ### `POST /api/v1/proxies`
@ -34,7 +33,7 @@ Créer un nouveau proxy
#### Exemple de corps de requête #### Exemple de corps de requête
```json5 ```json
{ {
"name": "myproxy", // OBLIGATOIRE - Nom du proxy "name": "myproxy", // OBLIGATOIRE - Nom du proxy
"to": "https://www.cadoles.com", // OBLIGATOIRE - Site distant ciblé par le proxy "to": "https://www.cadoles.com", // OBLIGATOIRE - Site distant ciblé par le proxy
@ -44,7 +43,7 @@ Créer un nouveau proxy
#### Exemple de résultat #### Exemple de résultat
```json5 ```json
{ {
"data": { "data": {
"proxy": { "proxy": {
@ -74,7 +73,7 @@ Récupérer les informations complètes sur un proxy
#### Exemple de résultat #### Exemple de résultat
```json5 ```json
{ {
"data": { "data": {
"proxy": { "proxy": {
@ -100,18 +99,18 @@ Modifier un proxy
#### Exemple de corps de requête #### 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 "from": ["mylocalproxydomain:*"], // OPTIONNEL - Liste de patrons de filtrage associés au proxy
"weight": 100, // OPTIONNEL - Poids à associer au proxy "weight": 100, // OPTIONNEL - Poids à associer au proxy
"enabled": true, // OPTIONNEL - Activer/désactiver le proxy "enabled": true // OPTIONNEL - Activer/désactiver le proxy
} }
``` ```
#### Exemple de résultat #### Exemple de résultat
```json5 ```json
{ {
"data": { "data": {
"proxy": { "proxy": {
@ -141,14 +140,14 @@ Lister les proxies existants
#### Exemple de résultat #### Exemple de résultat
```json5 ```json
{ {
"data": { "data": {
"proxies": [ "proxies": [
{ {
"name": "myproxy", "name": "myproxy",
"weight": 0, "weight": 0,
"enabled": false, "enabled": false
} }
] ]
} }
@ -169,7 +168,7 @@ Supprimer le proxy
#### Exemple de résultat #### Exemple de résultat
```json5 ```json
{ {
"data": { "data": {
"proxyName": "myproxy" "proxyName": "myproxy"