openstack
/
monasca-api
Code Issues Proposed changes

[doc] Fix incorrect formatting on get alarm count 

The spec for Get Alarm Count was appearing literally as:

  ##Get Alarm Counts Get the number of alarms that match the criteria.

  ###GET /v2.0/alarms/count
  etc.

It is now formatted so that the headings are rendered like corresponding entries.

Change-Id: Ic8ddc1fc3f56c00f22e8c0132a49be2cc7cd2fc1
Closes-Bug: #1696393
This commit is contained in:
Emma Foley 2017-06-07 11:03:19 +00:00 committed by Tomasz Trębski
parent 4b1b1681ab
commit 73066257a8
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/monasca-api-spec.md
View File

@ -2846,20 +2846,20 @@ Returns a JSON object with a 'links' array of links and an 'elements' array of a
```
___
##Get Alarm Counts
## Get Alarm Counts
Get the number of alarms that match the criteria.
###GET /v2.0/alarms/count
### GET /v2.0/alarms/count
####Headers
#### Headers
* X-Auth-Token (string, required) - Keystone auth token
* Content-Type (string, required) - application/json
* Accept (string) - application/json
####Path Parameters
#### Path Parameters
None
####Query Parameters
#### Query Parameters
* alarm_definition_id (string, optional) - Alarm definition ID to filter by.
* metric_name (string(255), optional) - Name of metric to filter by.
* metric_dimensions ({string(255): string(255)}, optional) - Dimensions of metrics to filter by specified as a comma separated array of (key, value) pairs as `key1:value1,key1:value1,...`
@ -2874,10 +2874,10 @@ None
The group_by field is limited to `alarm_definition_id`, `name`, `state`, `severity`, `link`, `lifecycle_state`, `metric_name`, `dimension_name`, `dimension_value`.
If any of the fields `metric_name`, `dimension_name`, or `dimension_value` are specified, the sum of the resulting counts is not guaranteed to equal the total number of alarms in the system. Alarms with multiple metrics may be included in multiple counts when grouped by any of these three fields.
####Request Body
#### Request Body
None
####Request Examples
#### Request Examples
```
GET /v2.0/alarms/count?metric_name=cpu.system_perc&metric_dimensions=hostname:devstack&group_by=state,lifecycle_state
HTTP/1.1 Host: 192.168.10.4:8070
@ -2886,17 +2886,17 @@ X-Auth-Token: 2b8882ba2ec44295bf300aecb2caa4f7
Cache-Control: no-cache
```
###Response
####Status Code
### Response
#### Status Code
* 200 OK
####Response Body
#### Response Body
Returns a JSON object containing the following fields:
* links ([link]) - Links to alarms count resource
* columns ([string]) - List of the column names, in the order they were returned
* counts ([array[]]) - A two dimensional array of the counts returned
####Response Example
#### Response Example
```
{
"links": [