MXS-1220: Add listener creation documentation
The documentation for creating listeners was not added.
This commit is contained in:
@ -226,9 +226,10 @@ POST /v1/servers
|
|||||||
```
|
```
|
||||||
|
|
||||||
Create a new server by defining the resource. The posted object must define the
|
Create a new server by defining the resource. The posted object must define the
|
||||||
_name_ field with the name of the server and the _parameters_ field with JSON
|
_data.id_ field with the name of the server and the
|
||||||
object containing values for the _address_ and _port_ parameters. The following
|
_data.atttributes.parameters_ field with JSON object containing values for the
|
||||||
is the minimal required JSON object for defining a new server.
|
_address_ and _port_ parameters. The following is the minimal required JSON
|
||||||
|
object for defining a new server.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
{
|
{
|
||||||
|
@ -259,6 +259,49 @@ GET /v1/services/:name/listeners
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Create a new listener
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
POST /v1/services/:name/listeners
|
||||||
|
```
|
||||||
|
|
||||||
|
Create a new listener for a service by defining the resource. The _:name_ in the
|
||||||
|
URI must map to a service name with all whitespace replaced with hyphens. The
|
||||||
|
posted object must define the _data.id_ field with the name of the server and
|
||||||
|
the _data.attributes.parameters.port_ field with the port where the listener
|
||||||
|
will listen on. The following is the minimal required JSON object for defining a
|
||||||
|
new listener.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": "my-listener",
|
||||||
|
"type": "listeners",
|
||||||
|
"attributes": {
|
||||||
|
"parameters": {
|
||||||
|
"port": 3306
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The following table contains all values that can be given in the _parameters_
|
||||||
|
object.
|
||||||
|
|
||||||
|
|Parameter | Description |
|
||||||
|
|-----------------------|---------------------------------------------------|
|
||||||
|
|port | Port to listen on |
|
||||||
|
|address | Interface to listen on |
|
||||||
|
|authenticator | Authenticator module |
|
||||||
|
|authenticator_options | Options for the authenticator |
|
||||||
|
|ssl_key | Path to SSL key |
|
||||||
|
|ssl_cert | Path to SSL certificate |
|
||||||
|
|ssl_ca_cert | Path to SSL CA certificate |
|
||||||
|
|ssl_version | The SSL version to use [TLSv1.2|TLSv1.1|TLSv1.0] |
|
||||||
|
|ssl_cert_verify_depth | Certificate verification depth |
|
||||||
|
|
||||||
### Update a service
|
### Update a service
|
||||||
|
|
||||||
The _:name_ in the URI must map to a service name and the request body must be a
|
The _:name_ in the URI must map to a service name and the request body must be a
|
||||||
|
Reference in New Issue
Block a user