openstack
/
ceilometer
Code Issues Proposed changes

Add metadata query validation limitation 

There is currently no way to pre-determine the schema of
resource_metadata. So it will be hard to validate when
running a query. This patch includes this limitation in
ceilometer documentation.

Change-Id: I804467c3bb8e7d336ae881b25434063839951724
Partial-Bug: #1245367
This commit is contained in:
David Peraza 2013-12-12 13:05:49 -06:00
parent 6cb9b88f09
commit e1a2d4427c
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -62,7 +62,12 @@ 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*). 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>*.
*metadata.<field>*. Notice, however, that given the free-form nature of
*resource_metadata* field, there is no practical or consistent way to
validate the query fields under *metadata* domain like it is done for all other
fields. In other words, the API call will return HTTP 200 in both scenarios:
when a query with *metadata.<field>* does not match its value, and when
*<field>* itself does not exist in any of the records being queried.
.. autotype:: ceilometer.api.controllers.v2.Query
:members: