hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MXS-1220: Update links in REST API documentation

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

14
Documentation/REST-API/API.md
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 MaxScale REST API provides the following resources. All resources conform to
the [JSON API](http://jsonapi.org/format/) specification. the [JSON API](http://jsonapi.org/format/) specification.
- [/maxscale](Resources-MaxScale.md) - [maxscale](Resources-MaxScale.md)
- [/services](Resources-Service.md) - [services](Resources-Service.md)
- [/servers](Resources-Server.md) - [servers](Resources-Server.md)
- [/filters](Resources-Filter.md) - [filters](Resources-Filter.md)
- [/monitors](Resources-Monitor.md) - [monitors](Resources-Monitor.md)
- [/sessions](Resources-Session.md) - [sessions](Resources-Session.md)
- [/users](Resources-User.md) - [users](Resources-User.md)
### Resource Relationships ### Resource Relationships

4
Documentation/REST-API/Resources-Filter.md
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. whitespace replaced with hyphens. The filter names are case-sensitive.
``` ```
GET /filters/:name GET /v1/filters/:name
``` ```
#### Response #### Response
@ -54,7 +54,7 @@ GET /filters/:name
Get all filters. Get all filters.
``` ```
GET /filters GET /v1/filters
``` ```
#### Response #### Response

16
Documentation/REST-API/Resources-MaxScale.md
View File

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

11
Documentation/REST-API/Resources-Monitor.md
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. all whitespace replaced with hyphens. The monitor names are case-sensitive.
``` ```
GET /monitors/:name GET /v1/monitors/:name
``` ```
#### Response #### Response
@ -117,7 +117,7 @@ GET /monitors/:name
Get all monitors. Get all monitors.
``` ```
GET /monitors GET /v1/monitors
``` ```
#### Response #### Response
@ -225,7 +225,7 @@ GET /monitors
Stops a started monitor. Stops a started monitor.
``` ```
PUT /monitor/:name/stop PUT /v1/monitor/:name/stop
``` ```
#### Response #### Response
@ -239,7 +239,7 @@ Monitor is stopped.
Starts a stopped monitor. Starts a stopped monitor.
``` ```
PUT /monitor/:name/start PUT /v1/monitor/:name/start
``` ```
#### Response #### 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. hyphens. The request body must be a valid JSON document representing the modified monitor.
``` ```
PUT /monitor/:name PUT /v1/monitor/:name
``` ```
### Modifiable Fields ### Modifiable Fields
@ -282,4 +282,3 @@ Monitor is modified.
Invalid request body. Invalid request body.
`Status: 403 Forbidden` `Status: 403 Forbidden`

4
Documentation/REST-API/Resources-Session.md
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 a single session. _:id_ must be a valid session ID.
``` ```
GET /sessions/:id GET /v1/sessions/:id
``` ```
#### Response #### Response
@ -59,7 +59,7 @@ GET /sessions/:id
Get all sessions. Get all sessions.
``` ```
GET /sessions GET /v1/sessions
``` ```
#### Response #### Response