openstack
/
api-site
Code Issues Proposed changes

Add delete method on alarm in Ceilometer API reference 

Ceilometer API v2 supports alarm deletion, but API reference doesn't
mention it.

Change-Id: If7491cf4f0465605ac952431feb9783bf330ddad
Closes-Bug: #1278743
This commit is contained in:
ZhiQiang Fan 2014-02-20 20:37:58 +08:00
parent 53d85a0ec0
commit 10ded9dc53
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api-ref/src/docbkx/ch_telemetry-v2.xml
View File

@ -22,6 +22,7 @@
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#alarm_id">
<wadl:method href="#showAlarm"/>
<wadl:method href="#updateAlarm"/>
<wadl:method href="#deleteAlarm"/>
</wadl:resource>
<wadl:resource
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#state">

11
api-ref/src/wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl
View File

@ -20,6 +20,7 @@
<resource path="{alarm_id}" id="alarm_id">
<method href="#showAlarm"/>
<method href="#updateAlarm"/>
<method href="#deleteAlarm"/>
<resource path="state" id="state">
<method href="#updateAlarmState"/>
<method href="#showAlarmState"/>
@ -319,7 +320,7 @@
<method id="showAlarm" name="GET">
<wadl:doc title="Show alarm" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Show information for a specified
<para role="shortdesc">Shows information for a specified
alarm.</para>
</wadl:doc>
<request/>
@ -414,4 +415,12 @@
<request/>
<response status="200"/>
</method>
<method id="deleteAlarm" name="DELETE">
<wadl:doc title="Delete alarm" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Deletes a specified alarm.</para>
</wadl:doc>
<request/>
<response status="204"/>
</method>
</application>