Update API doc

Get alarms returns alarm_definition, not alarm_deifinition_id
in response body.
Post notification method returns 201 response code, not 200.
Rerun doctoc.

Change-Id: I4117bad6c3032e3ef3e6f0391e3a716fb8304a38
This commit is contained in:
Shinya Kawabata 2015-12-08 16:09:08 +09:00
parent 3d751a4df7
commit f3705b39bd
4 changed files with 9 additions and 11 deletions

View File

@ -22,6 +22,7 @@ Document Version: v2.0
- [More Complex Example](#more-complex-example)
- [Compound alarm example](#compound-alarm-example)
- [Changing Alarm Definitions](#changing-alarm-definitions)
- [Notification Methods](#notification-methods)
- [Common Request Headers](#common-request-headers)
- [Common Http Request Headers](#common-http-request-headers)
- [Non-standard request headers](#non-standard-request-headers)
@ -32,7 +33,7 @@ Document Version: v2.0
- [JSON Results](#json-results)
- [Versions](#versions)
- [List Versions](#list-versions)
- [GET](#get)
- [GET /](#get-)
- [Headers](#headers)
- [Path Parameters](#path-parameters)
- [Query Parameters](#query-parameters)
@ -114,7 +115,7 @@ Document Version: v2.0
- [Status Code](#status-code-4)
- [Response Body](#response-body-6)
- [Response Examples](#response-examples-5)
- [Notification Methods](#notification-methods)
- [Notification Methods](#notification-methods-1)
- [Create Notification Method](#create-notification-method)
- [POST /v2.0/notification-methods](#post-v20notification-methods)
- [Headers](#headers-7)
@ -234,6 +235,7 @@ Document Version: v2.0
- [Response](#response-17)
- [Status Code](#status-code-15)
- [Response Body](#response-body-17)
- [Alarms](#alarms)
- [List Alarms](#list-alarms)
- [GET /v2.0/alarms](#get-v20alarms)
- [Headers](#headers-18)
@ -1369,7 +1371,7 @@ Cache-Control: no-cache
### Response
#### Status Code
* 200 - OK
* 201 - OK
#### Response Body
Returns a JSON notification method object with the following fields:
@ -2215,6 +2217,9 @@ Cache-Control: no-cache
None.
___
# Alarms
Operations for working with alarms.
## List Alarms
List alarms
@ -2260,7 +2265,7 @@ Returns a JSON object with a 'links' array of links and an 'elements' array of a
* id (string) - ID of alarm.
* links ([link]) - Links to alarm.
* alarm_definition_id (string) - Name of alarm.
* alarm_definition (JSON object) - Summary of alarm definition.
* metrics ({string, string(255): string(255)}) - The metrics associated with the alarm.
* state (string) - State of alarm, either `OK`, `ALARM` or `UNDETERMINED`.
* lifecycle_state (string) - Lifecycle state of alarm.

View File

@ -12,8 +12,6 @@
# License for the specific language governing permissions and limitations
# under the License.
# TODO(RMH): Update documentation. Get alarms returns alarm_definition, not
# TODO(RMH): alarm_definition_id in response body
import time
from monasca_tempest_tests.tests.api import base

View File

@ -12,8 +12,6 @@
# License for the specific language governing permissions and limitations
# under the License.
# TODO(RMH): Update documentation. Get alarms returns alarm_definition, not
# TODO(RMH): alarm_definition_id in response body
import time
from monasca_tempest_tests.tests.api import base

View File

@ -12,9 +12,6 @@
# License for the specific language governing permissions and limitations
# under the License.
# TODO(RMH): Validate whether a 200 or 201 should be returned and resolve.
# TODO(RMH): Documentation says 200, but a 201 is being returned.
import time
from monasca_tempest_tests.tests.api import base