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

MXS-2483: Document REST API corrections

Browse Source 
The protocol parameter must always be explicitly defined.
This commit is contained in:
Markus Mäkelä 2019-05-28 09:17:09 +03:00
parent 9443e99a17
commit 1d87a1c3bc
No known key found for this signature in database
GPG Key ID: 72D48FCE664F7B19
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -241,6 +241,10 @@ least the following fields.
* `data.type`
* Type of the object, must be `servers`
* `data.attributes.parameters.protocol`
* The [`protocol`](../Getting-Started/Configuration-Guide.md#protocol) to use.
Must be defined.
* `data.attributes.parameters.address` OR `data.attributes.parameters.socket`
* The [`address`](../Getting-Started/Configuration-Guide.md#address) or
[`socket`](../Getting-Started/Configuration-Guide.md#socket) to use. Only
@ -250,7 +254,6 @@ least the following fields.
* The [`port`](../Getting-Started/Configuration-Guide.md#port) to use. Needs
to be defined if the `address` field is defined.
The following is the minimal required JSON object for defining a new server.
```javascript

6
Documentation/Release-Notes/MaxScale-2.4.0-Release-Notes.md
View File

@ -45,6 +45,12 @@ improvement over the older MD5 hashing algorithm. New users will use the
stronger algorithm but old users will continue using the weaker one. To upgrade
administrative users, recreate the user.
### REST API - Server creation
The `protocol` parameter must now always be defined when a server is
created. The previously undocumented default value of `mariadbbackend` now must
be explicitly defined when a server is created via the REST API.
## Dropped Features
### `debugcli` and `telnetd`