Cadoles/bouncer
Cadoles
/
bouncer
10
0
Fork 0
Code Issues 2 Pull Requests 1 Projects Releases 3 Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
doc/fr/references/admin_api.md
View File

@ -22,9 +22,8 @@ Où:
- `"<subject>"` est une chaîne de caractère arbitraire ayant pour objectif d'identifier de manière unique l'utilisateur associé au jeton; - `"<subject>"` est une chaîne de caractère arbitraire ayant pour objectif d'identifier de manière unique l'utilisateur associé au jeton;
- `"<role>"` peut prendre une des deux valeurs `reader` ou `writer` correspondant aux droits suivants respectifs: - `"<role>"` 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 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
@ -34,29 +33,29 @@ 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
"from": ["*"] // OPTIONNEL - Liste de patrons de filtrage associés au proxy "from": ["*"] // OPTIONNEL - Liste de patrons de filtrage associés au proxy
} }
``` ```
#### Exemple de résultat #### Exemple de résultat
```json5 ```json
{ {
"data": { "data": {
"proxy": { "proxy": {
"name": "myproxy", "name": "myproxy",
"weight": 0, "weight": 0,
"enabled": false, "enabled": false,
"to": "https://www.cadoles.com", "to": "https://www.cadoles.com",
"from": ["*"], "from": ["*"],
"createdAt": "2018-12-10T13:45:00.000Z", "createdAt": "2018-12-10T13:45:00.000Z",
"updatedAt": "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 #### Exemple de résultat
```json5 ```json
{ {
"data": { "data": {
"proxy": { "proxy": {
"name": "myproxy", "name": "myproxy",
"weight": 0, "weight": 0,
"enabled": false, "enabled": false,
"to": "https://www.cadoles.com", "to": "https://www.cadoles.com",
"from": ["*"], "from": ["*"],
"createdAt": "2018-12-10T13:45:00.000Z", "createdAt": "2018-12-10T13:45:00.000Z",
"updatedAt": "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 #### 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": {
"name": "myproxy", "name": "myproxy",
"weight": 100, "weight": 100,
"enabled": true, "enabled": true,
"to": "https://www.cadoles.com", "to": "https://www.cadoles.com",
"from": ["mylocalproxydomain:*"], "from": ["mylocalproxydomain:*"],
"createdAt": "2018-12-10T13:45:00.000Z", "createdAt": "2018-12-10T13:45:00.000Z",
"updatedAt": "2020-10-02T15:09:00.000Z" "updatedAt": "2020-10-02T15:09:00.000Z"
}
} }
}
} }
``` ```
@ -141,17 +140,17 @@ 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,11 +168,11 @@ Supprimer le proxy
#### Exemple de résultat #### Exemple de résultat
```json5 ```json
{ {
"data": { "data": {
"proxyName": "myproxy" "proxyName": "myproxy"
} }
} }
``` ```