Merge pull request #11934 from liquidm/improve_alert_docs

Improve alert docs
This commit is contained in:
Carl Bergquist
2018-05-21 14:34:58 +02:00
committed by GitHub

View File

@ -49,18 +49,15 @@ Content-Type: application/json
``` ```
## Get one alert ## Get one alert
`GET /api/alerts/:id`
**Example Request**: **Example Request**:
```http
GET /api/alerts/1 HTTP/1.1
Accept: application/json Accept: application/json
```http Content-Type: application/json
GET /api/alerts/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
``` ```
@ -88,16 +85,35 @@ Content-Type: application/json
```http ```http
POST /api/alerts/1/pause HTTP/1.1 POST /api/alerts/1/pause HTTP/1.1
Accept: application/json Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
``` ```
HTTP/1.1 200 The :id query parameter is the id of the alert to be paused or unpaused.
JSON Body Schema:
- **paused** Can be `true` or `false`. True to pause an alert. False to unpause an alert.
**Example Response**:
```http
HTTP/1.1 200
Content-Type: application/json
{
``` ```
## Pause all alerts ## Pause all alerts
`POST /api/admin/pause-all-alerts` `POST /api/admin/pause-all-alerts`
```http
POST /api/admin/pause-all-alerts HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
``` ```
JSON Body Schema: JSON Body Schema: