MXS-1220: Update links in REST API documentation

Added missing v1 prefixes to links.
This commit is contained in:
Markus Mäkelä 2017-05-22 12:53:16 +03:00
parent c54710cfaa
commit 9ccb54c107
5 changed files with 24 additions and 25 deletions

View File

@ -26,13 +26,13 @@ of the comment and extend to the end of the current line.
The MaxScale REST API provides the following resources. All resources conform to
the [JSON API](http://jsonapi.org/format/) specification.
- [/maxscale](Resources-MaxScale.md)
- [/services](Resources-Service.md)
- [/servers](Resources-Server.md)
- [/filters](Resources-Filter.md)
- [/monitors](Resources-Monitor.md)
- [/sessions](Resources-Session.md)
- [/users](Resources-User.md)
- [maxscale](Resources-MaxScale.md)
- [services](Resources-Service.md)
- [servers](Resources-Server.md)
- [filters](Resources-Filter.md)
- [monitors](Resources-Monitor.md)
- [sessions](Resources-Session.md)
- [users](Resources-User.md)
### Resource Relationships

View File

@ -11,7 +11,7 @@ Get a single filter. The _:name_ in the URI must be a valid filter name with all
whitespace replaced with hyphens. The filter names are case-sensitive.
```
GET /filters/:name
GET /v1/filters/:name
```
#### Response
@ -54,7 +54,7 @@ GET /filters/:name
Get all filters.
```
GET /filters
GET /v1/filters
```
#### Response

View File

@ -11,7 +11,7 @@ Retrieve global information about a MaxScale instance. This includes various
file locations, configuration options and version information.
```
GET /maxscale
GET /v1/maxscale
```
#### Response
@ -70,7 +70,7 @@ the URI must map to a valid thread number between 0 and the configured
value of `threads`.
```
GET /maxscale/threads/:id
GET /v1/maxscale/threads/:id
```
#### Response
@ -115,7 +115,7 @@ GET /maxscale/threads/:id
Get the informatino for all threads. Returns a collection of threads resources.
```
GET /maxscale/threads
GET /v1/maxscale/threads
```
#### Response
@ -226,7 +226,7 @@ Get information about the current state of logging, enabled log files and the
location where the log files are stored.
```
GET /maxscale/logs
GET /v1/maxscale/logs
```
#### Response
@ -271,7 +271,7 @@ Flushes any pending messages to disk and reopens the log files. The body of the
message is ignored.
```
POST /maxscale/logs/flush
POST /v1/maxscale/logs/flush
```
#### Response
@ -285,7 +285,7 @@ Status: 204 No Content
Retrieve all pending tasks that are queued for execution.
```
GET /maxscale/tasks
GET /v1/maxscale/tasks
```
#### Response
@ -311,7 +311,7 @@ Retrieve information about a loaded module. This includes version, API and
maturity information as well as all the parameters that the module defines.
```
GET /maxscale/modules
GET /v1/maxscale/modules
```
#### Response
@ -421,7 +421,7 @@ GET /maxscale/modules
Retrieve information about all loaded modules.
```
GET /maxscale/modules
GET /v1/maxscale/modules
```
#### Response

View File

@ -11,7 +11,7 @@ Get a single monitor. The _:name_ in the URI must be a valid monitor name with
all whitespace replaced with hyphens. The monitor names are case-sensitive.
```
GET /monitors/:name
GET /v1/monitors/:name
```
#### Response
@ -117,7 +117,7 @@ GET /monitors/:name
Get all monitors.
```
GET /monitors
GET /v1/monitors
```
#### Response
@ -225,7 +225,7 @@ GET /monitors
Stops a started monitor.
```
PUT /monitor/:name/stop
PUT /v1/monitor/:name/stop
```
#### Response
@ -239,7 +239,7 @@ Monitor is stopped.
Starts a stopped monitor.
```
PUT /monitor/:name/start
PUT /v1/monitor/:name/start
```
#### Response
@ -254,7 +254,7 @@ The :name in the URI must map to a monitor name with all whitespace replaced wit
hyphens. The request body must be a valid JSON document representing the modified monitor.
```
PUT /monitor/:name
PUT /v1/monitor/:name
```
### Modifiable Fields
@ -282,4 +282,3 @@ Monitor is modified.
Invalid request body.
`Status: 403 Forbidden`

View File

@ -11,7 +11,7 @@ session is created on a service and each service can have multiple sessions.
Get a single session. _:id_ must be a valid session ID.
```
GET /sessions/:id
GET /v1/sessions/:id
```
#### Response
@ -59,7 +59,7 @@ GET /sessions/:id
Get all sessions.
```
GET /sessions
GET /v1/sessions
```
#### Response