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:
parent
3d751a4df7
commit
f3705b39bd
|
@ -22,6 +22,7 @@ Document Version: v2.0
|
||||||
- [More Complex Example](#more-complex-example)
|
- [More Complex Example](#more-complex-example)
|
||||||
- [Compound alarm example](#compound-alarm-example)
|
- [Compound alarm example](#compound-alarm-example)
|
||||||
- [Changing Alarm Definitions](#changing-alarm-definitions)
|
- [Changing Alarm Definitions](#changing-alarm-definitions)
|
||||||
|
- [Notification Methods](#notification-methods)
|
||||||
- [Common Request Headers](#common-request-headers)
|
- [Common Request Headers](#common-request-headers)
|
||||||
- [Common Http Request Headers](#common-http-request-headers)
|
- [Common Http Request Headers](#common-http-request-headers)
|
||||||
- [Non-standard request headers](#non-standard-request-headers)
|
- [Non-standard request headers](#non-standard-request-headers)
|
||||||
|
@ -32,7 +33,7 @@ Document Version: v2.0
|
||||||
- [JSON Results](#json-results)
|
- [JSON Results](#json-results)
|
||||||
- [Versions](#versions)
|
- [Versions](#versions)
|
||||||
- [List Versions](#list-versions)
|
- [List Versions](#list-versions)
|
||||||
- [GET](#get)
|
- [GET /](#get-)
|
||||||
- [Headers](#headers)
|
- [Headers](#headers)
|
||||||
- [Path Parameters](#path-parameters)
|
- [Path Parameters](#path-parameters)
|
||||||
- [Query Parameters](#query-parameters)
|
- [Query Parameters](#query-parameters)
|
||||||
|
@ -114,7 +115,7 @@ Document Version: v2.0
|
||||||
- [Status Code](#status-code-4)
|
- [Status Code](#status-code-4)
|
||||||
- [Response Body](#response-body-6)
|
- [Response Body](#response-body-6)
|
||||||
- [Response Examples](#response-examples-5)
|
- [Response Examples](#response-examples-5)
|
||||||
- [Notification Methods](#notification-methods)
|
- [Notification Methods](#notification-methods-1)
|
||||||
- [Create Notification Method](#create-notification-method)
|
- [Create Notification Method](#create-notification-method)
|
||||||
- [POST /v2.0/notification-methods](#post-v20notification-methods)
|
- [POST /v2.0/notification-methods](#post-v20notification-methods)
|
||||||
- [Headers](#headers-7)
|
- [Headers](#headers-7)
|
||||||
|
@ -234,6 +235,7 @@ Document Version: v2.0
|
||||||
- [Response](#response-17)
|
- [Response](#response-17)
|
||||||
- [Status Code](#status-code-15)
|
- [Status Code](#status-code-15)
|
||||||
- [Response Body](#response-body-17)
|
- [Response Body](#response-body-17)
|
||||||
|
- [Alarms](#alarms)
|
||||||
- [List Alarms](#list-alarms)
|
- [List Alarms](#list-alarms)
|
||||||
- [GET /v2.0/alarms](#get-v20alarms)
|
- [GET /v2.0/alarms](#get-v20alarms)
|
||||||
- [Headers](#headers-18)
|
- [Headers](#headers-18)
|
||||||
|
@ -1369,7 +1371,7 @@ Cache-Control: no-cache
|
||||||
### Response
|
### Response
|
||||||
|
|
||||||
#### Status Code
|
#### Status Code
|
||||||
* 200 - OK
|
* 201 - OK
|
||||||
|
|
||||||
#### Response Body
|
#### Response Body
|
||||||
Returns a JSON notification method object with the following fields:
|
Returns a JSON notification method object with the following fields:
|
||||||
|
@ -2215,6 +2217,9 @@ Cache-Control: no-cache
|
||||||
None.
|
None.
|
||||||
___
|
___
|
||||||
|
|
||||||
|
# Alarms
|
||||||
|
Operations for working with alarms.
|
||||||
|
|
||||||
## List Alarms
|
## List 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.
|
* id (string) - ID of alarm.
|
||||||
* links ([link]) - Links to 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.
|
* metrics ({string, string(255): string(255)}) - The metrics associated with the alarm.
|
||||||
* state (string) - State of alarm, either `OK`, `ALARM` or `UNDETERMINED`.
|
* state (string) - State of alarm, either `OK`, `ALARM` or `UNDETERMINED`.
|
||||||
* lifecycle_state (string) - Lifecycle state of alarm.
|
* lifecycle_state (string) - Lifecycle state of alarm.
|
||||||
|
|
|
@ -12,8 +12,6 @@
|
||||||
# License for the specific language governing permissions and limitations
|
# License for the specific language governing permissions and limitations
|
||||||
# under the License.
|
# under the License.
|
||||||
|
|
||||||
# TODO(RMH): Update documentation. Get alarms returns alarm_definition, not
|
|
||||||
# TODO(RMH): alarm_definition_id in response body
|
|
||||||
import time
|
import time
|
||||||
|
|
||||||
from monasca_tempest_tests.tests.api import base
|
from monasca_tempest_tests.tests.api import base
|
||||||
|
|
|
@ -12,8 +12,6 @@
|
||||||
# License for the specific language governing permissions and limitations
|
# License for the specific language governing permissions and limitations
|
||||||
# under the License.
|
# under the License.
|
||||||
|
|
||||||
# TODO(RMH): Update documentation. Get alarms returns alarm_definition, not
|
|
||||||
# TODO(RMH): alarm_definition_id in response body
|
|
||||||
import time
|
import time
|
||||||
|
|
||||||
from monasca_tempest_tests.tests.api import base
|
from monasca_tempest_tests.tests.api import base
|
||||||
|
|
|
@ -12,9 +12,6 @@
|
||||||
# License for the specific language governing permissions and limitations
|
# License for the specific language governing permissions and limitations
|
||||||
# under the License.
|
# 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
|
import time
|
||||||
|
|
||||||
from monasca_tempest_tests.tests.api import base
|
from monasca_tempest_tests.tests.api import base
|
||||||
|
|
Loading…
Reference in New Issue