4b794472a8
This changes the documentation layout according to the previously submitted spec. Change-Id: I9aa879af23ae4e993da60186eddaef8d22f59e79 Story: 2004179 Task: 28152
98 lines
2.5 KiB
ReStructuredText
98 lines
2.5 KiB
ReStructuredText
========================
|
|
CloudKitty REST API (v1)
|
|
========================
|
|
|
|
Collector
|
|
=========
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.collector:CollectorController
|
|
:webprefix: /v1/collector
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.collector:MappingController
|
|
:webprefix: /v1/collector/mappings
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.collector:CollectorStateController
|
|
:webprefix: /v1/collector/states
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.collector.CollectorInfos
|
|
:members:
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.collector.ServiceToCollectorMapping
|
|
:members:
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.collector.ServiceToCollectorMappingCollection
|
|
:members:
|
|
|
|
|
|
Info
|
|
====
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.info:InfoController
|
|
:webprefix: /v1/info
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.info:MetricInfoController
|
|
:webprefix: /v1/info/metric
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.info.CloudkittyMetricInfo
|
|
:members:
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.info.CloudkittyMetricInfoCollection
|
|
:members:
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.info:ServiceInfoController
|
|
:webprefix: /v1/info/service
|
|
|
|
|
|
Rating
|
|
======
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.rating:ModulesController
|
|
:webprefix: /v1/rating/modules
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.rating:ModulesExposer
|
|
:webprefix: /v1/rating/module_config
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.rating:RatingController
|
|
:webprefix: /v1/rating
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.rating.CloudkittyModule
|
|
:members:
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.rating.CloudkittyModuleCollection
|
|
:members:
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.rating.CloudkittyResource
|
|
:members:
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.rating.CloudkittyResourceCollection
|
|
:members:
|
|
|
|
.. include:: rating/hashmap.rst
|
|
|
|
.. include:: rating/pyscripts.rst
|
|
|
|
Report
|
|
======
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.report:ReportController
|
|
:webprefix: /v1/report
|
|
|
|
|
|
Storage
|
|
=======
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.storage:StorageController
|
|
:webprefix: /v1/storage
|
|
|
|
.. rest-controller:: cloudkitty.api.v1.controllers.storage:DataFramesController
|
|
:webprefix: /v1/storage/dataframes
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.storage.RatedResource
|
|
:members:
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.storage.DataFrame
|
|
:members:
|
|
|
|
.. autotype:: cloudkitty.api.v1.datamodels.storage.DataFrameCollection
|
|
:members:
|