openstack/api-site
Code Issues Proposed changes

Merge "Add events description for ceilometer v2"

Browse Source
This commit is contained in:
Jenkins 2015-11-18 21:28:57 +00:00 committed by Gerrit Code Review
commit 1b00f131dd
5 changed files with 133 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -285,4 +285,18 @@
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="events">
<title>Events</title>
<para>Lists all events and shows details for an event.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#events">
<wadl:method href="#listEvents"/>
</wadl:resource>
<wadl:resource
href="../wadls/telemetry-api/src/v2/os-telemetry-api-2.0.wadl#message_id">
<wadl:method href="#showEvent"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

28
api-ref/src/wadls/telemetry-api/src/v2/common.ent
View File

@ -684,3 +684,31 @@
<programlisting>GET /v2/meters/METER_NAME/statistics?aggregate.func=cardinality&amp;aggregate.param=resource_id&amp;aggregate.func=cardinality&amp;aggregate.param=project_id</programlisting>
</wadl:doc>
</param>'>
<!ENTITY eventQueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="q" required="false" style="query"
type="xsd:list">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Filters the response by one or more event arguments.
</para>
<para>
For example:
</para>
<programlisting>GET /v2/events?q.field=Foo&amp;q.value=my_text</programlisting>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit" required="false" style="query"
type="xsd:int">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Limits the maximum number of samples that are returned in the
response.
</para>
<para>
For example:
</para>
<programlisting>GET /v2/events?limit=1000</programlisting>
</wadl:doc>
</param>'>

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

@ -48,6 +48,21 @@
</resource>
</resource>
</resource>
<resource path="events" id="events">
<method href="#listEvents"/>
<resource path="{message_id}" id="message_id">
<param name="message_id" required="true"
style="template" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
The ID of the message.
</para>
</wadl:doc>
</param>
<method href="#showEvent"/>
</resource>
</resource>
<resource path="meters" id="meters">
<method href="#listMeters"/>
<resource path="{meter_name}" id="meter_name">
@ -775,4 +790,42 @@
</wadl:doc>
<response status="204"/>
</method>
<method id="listEvents" name="GET">
<wadl:doc title="List events" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Lists all events.
</para>
</wadl:doc>
<request>
<representation mediaType="application/xml">
&eventQueryParameter;
</representation>
</request>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="./samples/list_event.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method id="showEvent" name="GET">
<wadl:doc title="Show event details" xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">
Shows details for an event.
</para>
</wadl:doc>
<request/>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xml:lang="EN"
xmlns="http://docbook.org/ns/docbook">
<xsdxt:code href="./samples/list_event.json"/>
</wadl:doc>
</representation>
</response>
</method>
</application>

20
api-ref/src/wadls/telemetry-api/src/v2/samples/list_event.json Normal file
View File

@ -0,0 +1,20 @@
[
{
"raw": {},
"traits": [
{
"type": "string",
"name": "action",
"value": "read"
},
{
"type": "string",
"name": "eventTime",
"value": "2015-10-28T20:26:58.545477+0000"
}
],
"generated": "2015-10-28T20:26:58.546933",
"message_id": "bae43de6-e9fa-44ad-8c15-40a852584444",
"event_type": "http.request"
}
]

18
api-ref/src/wadls/telemetry-api/src/v2/samples/show_event.json Normal file
View File

@ -0,0 +1,18 @@
{
"raw": {},
"traits": [
{
"type": "string",
"name": "action",
"value": "read"
},
{
"type": "string",
"name": "eventTime",
"value": "2015-10-28T20:26:58.545477+0000"
}
],
"generated": "2015-10-28T20:26:58.546933",
"message_id": "bae43de6-e9fa-44ad-8c15-40a852584444",
"event_type": "http.request"
}