Documentation improvements

This commit is contained in:
Thorhallur Sverrisson 2015-09-23 02:11:46 +00:00
parent a07e395181
commit c263560401

View file

@ -254,11 +254,12 @@ $ curl -s "http://localhost:8080/health" | jq .
}
```
* ```/api```: ```GET``` or ```PUT``` a configuration
* ```/api```: ```GET``` configuration for all providers
```sh
$ curl -s "http://localhost:8082/api" | jq .
{
"file": {
"Frontends": {
"frontend-traefik": {
"Routes": {
@ -321,16 +322,41 @@ $ curl -s "http://localhost:8082/api" | jq .
}
}
}
},
"marathon": {
"Frontends": {
"frontend-marathon": {
"Routes": {
"route-host-marathon": {
"Value": "marathon.docker.localhost",
"Rule": "Host"
}
},
"Backend": "backend-marathon"
},
},
"Backends": {
"backend-marathon": {
"Servers": {
"server-marathon-1": {
"Weight": 0,
"Url": "http://172.17.0.8:802"
},
},
},
},
},
}
```
* ```/api/backends```: ```GET``` backends
* ```/api/backends/{backend}```: ```GET``` a backend
* ```/api/backends/{backend}/servers```: ```GET``` servers in a backend
* ```/api/backends/{backend}/servers/{server}```: ```GET``` a server in a backend
* ```/api/frontends```: ```GET``` frontends
* ```/api/frontends/{frontend}```: ```GET``` a frontend
* ```/api/{provider}```: ```GET``` or ```PUT``` provider
* ```/api/{provider}/backends```: ```GET``` backends
* ```/api/{provider}/backends/{backend}```: ```GET``` a backend
* ```/api/{provider}/backends/{backend}/servers```: ```GET``` servers in a backend
* ```/api/{provider}/backends/{backend}/servers/{server}```: ```GET``` a server in a backend
* ```/api/{provider}/frontends```: ```GET``` frontends
* ```/api/{provider}/frontends/{frontend}```: ```GET``` a frontend
## <a id="docker"></a> Docker backend