MXS-1220: Remove redundant parameter documentation
As all requests support the only parameter `pretty`, there's no point in documenting it separately for each resource.
This commit is contained in:
parent
43386333b3
commit
c98f8369f2
@ -81,8 +81,7 @@ in addition to the _self_ link.
|
||||
|
||||
## Common Request Parameters
|
||||
|
||||
Most of the resources that support GET also support the following
|
||||
parameters. See the resource documentation for a list of supported request
|
||||
All the resources that return JSON content also support the following
|
||||
parameters.
|
||||
|
||||
- `pretty`
|
||||
|
@ -45,10 +45,6 @@ GET /v1/filters/:name
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Get all filters
|
||||
|
||||
Get all filters.
|
||||
@ -89,7 +85,3 @@ GET /v1/filters
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
@ -59,10 +59,6 @@ GET /v1/maxscale
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
## Get thread information
|
||||
|
||||
Get the information and statistics of a particular thread. The _:id_ in
|
||||
@ -106,10 +102,6 @@ GET /v1/maxscale/threads/:id
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
## Get information for all threads
|
||||
|
||||
Get the informatino for all threads. Returns a collection of threads resources.
|
||||
@ -216,10 +208,6 @@ GET /v1/maxscale/threads
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
## Get logging information
|
||||
|
||||
Get information about the current state of logging, enabled log files and the
|
||||
@ -261,10 +249,6 @@ GET /v1/maxscale/logs
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
## Flush and rotate log files
|
||||
|
||||
Flushes any pending messages to disk and reopens the log files. The body of the
|
||||
@ -301,10 +285,6 @@ GET /v1/maxscale/tasks
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
## Get loaded modules
|
||||
|
||||
Retrieve information about a loaded module. This includes version, API and
|
||||
@ -412,10 +392,6 @@ GET /v1/maxscale/modules
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
## Get all loaded modules
|
||||
|
||||
Retrieve information about all loaded modules.
|
||||
@ -467,7 +443,3 @@ GET /v1/maxscale/modules
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
@ -108,10 +108,6 @@ GET /v1/monitors/:name
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Get all monitors
|
||||
|
||||
Get all monitors.
|
||||
@ -216,10 +212,6 @@ GET /v1/monitors
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Create a monitor
|
||||
|
||||
Create a new monitor. The request body must define the `/data/id`
|
||||
@ -232,7 +224,7 @@ be defined at creation time.
|
||||
|
||||
The following example defines a request body which creates the new monitor,
|
||||
_test-monitor_, and assigns two servers to be monitored by it. It also defines
|
||||
a custom value for the _monitor_interval_ parameter.
|
||||
a custom value for the _monitor_interval_ parameter.
|
||||
|
||||
```javascript
|
||||
{
|
||||
@ -258,7 +250,7 @@ a custom value for the _monitor_interval_ parameter.
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
@ -91,10 +91,6 @@ Server not found:
|
||||
Status: 404 Not Found
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Get all servers
|
||||
|
||||
```
|
||||
@ -223,10 +219,6 @@ Status: 200 OK
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Create a server
|
||||
|
||||
```
|
||||
@ -478,10 +470,6 @@ Invalid JSON body:
|
||||
Status: 403 Forbidden
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Destroy a server
|
||||
|
||||
```
|
||||
@ -525,8 +513,6 @@ GET /v1/servers/:name/connections
|
||||
|
||||
#### Response
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
### Close all connections to a server
|
||||
|
||||
Close all connections to a particular server. This will forcefully close all
|
||||
|
@ -86,10 +86,6 @@ GET /v1/services/:name
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Get all services
|
||||
|
||||
Get all services.
|
||||
@ -228,10 +224,6 @@ GET /v1/services
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Get service listeners
|
||||
|
||||
Get the listeners of a service. The _:name_ in the URI must be a valid service
|
||||
@ -267,10 +259,6 @@ GET /v1/services/:name/listeners
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Update a service
|
||||
|
||||
The _:name_ in the URI must map to a service name and the request body must be a
|
||||
|
@ -50,10 +50,6 @@ GET /v1/sessions/:id
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Get all sessions
|
||||
|
||||
Get all sessions.
|
||||
@ -147,7 +143,3 @@ GET /v1/sessions
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
@ -33,10 +33,6 @@ GET /v1/users/inet/:name
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Get all network users
|
||||
|
||||
Get all network users.
|
||||
@ -66,10 +62,6 @@ GET /v1/users/inet
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Get enabled UNIX account
|
||||
|
||||
Get a single enabled UNIX account. The The _:name_ in the URI must be a valid
|
||||
@ -100,10 +92,6 @@ GET /v1/users/unix/:name
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Get all enabled UNIX accounts
|
||||
|
||||
Get all enabled UNIX accounts.
|
||||
@ -133,10 +121,6 @@ GET /v1/users/unix
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Get all users
|
||||
|
||||
Get all administrative users. This fetches both network users and local UNIX
|
||||
@ -174,10 +158,6 @@ GET /v1/users
|
||||
}
|
||||
```
|
||||
|
||||
#### Supported Request Parameter
|
||||
|
||||
- `pretty`
|
||||
|
||||
### Create a network user
|
||||
|
||||
Create a new network user.
|
||||
|
Loading…
x
Reference in New Issue
Block a user