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

Fix REST API servers documentation

Browse Source 
Always use plural form of the objects. PATCH example used PUT.
This commit is contained in:
Markus Mäkelä
2020-03-18 10:41:39 +02:00
parent 5121aa296e
commit a8e2584bfc
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/REST-API/API.md
View File

@ -213,7 +213,7 @@ must be one of the methods that the requested resource supports.
#### Allow #### Allow
All resources return the Allow header with the supported HTTP methods. For All resources return the Allow header with the supported HTTP methods. For
example the resource `/service` will always return the `Accept: GET, PATCH, PUT` example the resource `/services` will always return the `Accept: GET, PATCH, PUT`
header. header.
#### Accept-Patch #### Accept-Patch
@ -317,7 +317,7 @@ representation of the error.
```javascript ```javascript
{ {
"error": { "error": {
"detail" : "The new `/server/` resource is missing the `port` parameter" "detail" : "The new `/servers/` resource is missing the `port` parameter"
} }
} }
``` ```

4
Documentation/REST-API/Resources-Server.md
View File

@ -367,7 +367,7 @@ _server1_ from the service _RW-Split-Router_.
Removing a service from a server is analogous to removing the server from the Removing a service from a server is analogous to removing the server from the
service. Both unlink the two objects from each other. service. Both unlink the two objects from each other.
Response to `GET /v1/server/server1`: Response to `GET /v1/servers/server1`:
```javascript ```javascript
{ {
@ -433,7 +433,7 @@ Response to `GET /v1/server/server1`:
} }
``` ```
Request for `PUT /v1/server/server1`: Request for `PATCH /v1/servers/server1`:
```javascript ```javascript
{ {