Doug Hellmann e14b326309 Update V2 API documentation

This changeset adds a Sphinx extension for auto-generating
much of the documentation for a Pecan/WSME API from the
comments and docstrings in the source code. It also updates
the V2 API to include more documentation for API endpoints
and the data types used in the API, as well as sample data
for generating the JSON and XML examples in the output
documentation.

Change-Id: I1bde7805550aa86e9b64495b5c6034ec328479e5
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>

2013-02-04 17:34:01 -05:00

888 B

Raw Blame History

V2 Web API

Resources

ceilometer.api.controllers.v2:ResourcesController

ceilometer.api.controllers.v2.Resource

Meters

ceilometer.api.controllers.v2:MetersController

ceilometer.api.controllers.v2:MeterController

Samples and Statistics

ceilometer.api.controllers.v2.Meter

ceilometer.api.controllers.v2.Sample

ceilometer.api.controllers.v2.Statistics

Filtering Queries

Many of the endpoints above accecpt a query filter argument, which should be a list of Query data structures:

ceilometer.api.controllers.v2.Query

888 B Raw Blame History