e14b326309
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>
43 lines
888 B
ReStructuredText
43 lines
888 B
ReStructuredText
============
|
|
V2 Web API
|
|
============
|
|
|
|
Resources
|
|
=========
|
|
|
|
.. rest-controller:: ceilometer.api.controllers.v2:ResourcesController
|
|
:webprefix: /v2/resources
|
|
|
|
.. autotype:: ceilometer.api.controllers.v2.Resource
|
|
:members:
|
|
|
|
Meters
|
|
======
|
|
|
|
.. rest-controller:: ceilometer.api.controllers.v2:MetersController
|
|
:webprefix: /v2/meters
|
|
|
|
.. rest-controller:: ceilometer.api.controllers.v2:MeterController
|
|
:webprefix: /v2/meters
|
|
|
|
Samples and Statistics
|
|
======================
|
|
|
|
.. autotype:: ceilometer.api.controllers.v2.Meter
|
|
:members:
|
|
|
|
.. autotype:: ceilometer.api.controllers.v2.Sample
|
|
:members:
|
|
|
|
.. autotype:: ceilometer.api.controllers.v2.Statistics
|
|
:members:
|
|
|
|
Filtering Queries
|
|
=================
|
|
|
|
Many of the endpoints above accecpt a query filter argument, which
|
|
should be a list of Query data structures:
|
|
|
|
.. autotype:: ceilometer.api.controllers.v2.Query
|
|
:members:
|