From e48e1736d7306224b86b29db54a3436a37e38e7e Mon Sep 17 00:00:00 2001 From: ZhiQiang Fan Date: Sun, 2 Nov 2014 14:54:51 +0800 Subject: [PATCH] Add Sample ReST API path in webapi document Sample type has been described in webapi document, but API path is missing, this patch fixes it. Change-Id: I09248aac036479c9ccd250824de4df05713bfaa1 Closes-Bug: #1388507 --- ceilometer/api/controllers/v2.py | 4 ++-- doc/source/webapi/v2.rst | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/ceilometer/api/controllers/v2.py b/ceilometer/api/controllers/v2.py index 96603efcd..9c0d830ec 100644 --- a/ceilometer/api/controllers/v2.py +++ b/ceilometer/api/controllers/v2.py @@ -1162,9 +1162,9 @@ class SamplesController(rest.RestController): @wsme_pecan.wsexpose(Sample, wtypes.text) def get_one(self, sample_id): - """Return a sample + """Return a sample. - :param sample_id: the id of the sample + :param sample_id: the id of the sample. """ f = storage.SampleFilter(message_id=sample_id) diff --git a/doc/source/webapi/v2.rst b/doc/source/webapi/v2.rst index 7ca235f21..27cefc937 100644 --- a/doc/source/webapi/v2.rst +++ b/doc/source/webapi/v2.rst @@ -31,6 +31,9 @@ Meters Samples and Statistics ====================== +.. rest-controller:: ceilometer.api.controllers.v2:SamplesController + :webprefix: /v2/samples + .. autotype:: ceilometer.api.controllers.v2.Sample :members: