From 0595402c255eafd9ae00a0867d560d7a7681f71c Mon Sep 17 00:00:00 2001 From: Eoghan Glynn Date: Fri, 28 Mar 2014 16:36:29 +0000 Subject: [PATCH] Add note on aggregate duplication to API docco Provide some additional clarity on allowable duplication in the selectable aggregates passed to a statistics query. Change-Id: If534e0667aa08fd531bbf31032e7648f7b80890c --- doc/source/webapi/v2.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/source/webapi/v2.rst b/doc/source/webapi/v2.rst index 97f0d5ea5..c24ed5b85 100644 --- a/doc/source/webapi/v2.rst +++ b/doc/source/webapi/v2.rst @@ -48,8 +48,13 @@ standard set by specifying an aggregate function in the statistics query:: GET /v2/meters//statistics?aggregate.func=&aggregate.param= -(where aggregate.param is optional). See the :ref:`functional-examples` -section for more detail. +(where aggregate.param is optional). + +Duplicate aggregate function and parameter pairs are silently discarded from the statistics query. Partial duplicates, in the sense of the same function but differing parameters, for example:: + + GET /v2/meters//statistics?aggregate.func=cardinality&aggregate.param=resource_id&aggregate.func=cardinality&aggregate.param=project_id + +are, on the other hand, both allowed by the API and supported by the storage drivers. See the :ref:`functional-examples` section for more detail. .. note:: Currently only *cardinality* needs aggregate.param to be specified.