openstack/aodh
Code Issues Proposed changes

Doc: clearly state that one can filter on metadata

Browse Source 
Currently, a few examples are given, but it's not clearly stated that it's
possible to run filter on the metadata as well as on the sample fields.

Change-Id: I765abc88e4b658bf3272e0a17d8def3d95eda27e
This commit is contained in:
Cyril Roelandt 2013-08-16 14:20:06 +00:00
parent a1674cda4f
commit fabbb517bc
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/webapi/v2.rst
View File

@ -50,7 +50,9 @@ should be a list of Query data structures. Whatever the endpoint you
want to apply a filter on, you always filter on the fields of the *Sample*
type (for example, if you apply a filter on a query for statistics,
you won't target *duration_start* field of *Statistics*, but *timestamp*
field of *Sample*):
field of *Sample*). You may also apply filters based on the values of one
or more of the *resource_metadata* field, in which case you should target
*metadata.<field>*.
.. autotype:: ceilometer.api.controllers.v2.Query
:members: