openstack/cloudkitty
Code Issues Proposed changes

Fix build error of api-ref

Browse Source 
Fix the following error breaking build of api reference.

```
ERROR: An option to autotype is either unknown or has an invalid
value: 'members'
```

Change-Id: I9795523c669231d74778d83eb7a67e41f0582da4
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
This commit is contained in:
Takashi Kajinami
2025-12-23 00:13:22 +09:00
parent 329de96838
commit 0f3ff87465
3 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
api-ref/source/v1/rating/hashmap.rst
View File

@@ -8,41 +8,41 @@ HashMap Module REST API
.. rest-controller:: cloudkitty.rating.hash.controllers.service:HashMapServicesController
:webprefix: /v1/rating/module_config/hashmap/services
.. autotype:: cloudkitty.rating.hash.datamodels.service.Service
.. autoclass:: cloudkitty.rating.hash.datamodels.service.Service
:members:
.. autotype:: cloudkitty.rating.hash.datamodels.service.ServiceCollection
.. autoclass:: cloudkitty.rating.hash.datamodels.service.ServiceCollection
:members:
.. rest-controller:: cloudkitty.rating.hash.controllers.field:HashMapFieldsController
:webprefix: /v1/rating/module_config/hashmap/fields
.. autotype:: cloudkitty.rating.hash.datamodels.field.Field
.. autoclass:: cloudkitty.rating.hash.datamodels.field.Field
:members:
.. autotype:: cloudkitty.rating.hash.datamodels.field.FieldCollection
.. autoclass:: cloudkitty.rating.hash.datamodels.field.FieldCollection
:members:
.. rest-controller:: cloudkitty.rating.hash.controllers.mapping:HashMapMappingsController
:webprefix: /v1/rating/module_config/hashmap/mappings
.. autotype:: cloudkitty.rating.hash.datamodels.mapping.Mapping
.. autoclass:: cloudkitty.rating.hash.datamodels.mapping.Mapping
:members:
.. autotype:: cloudkitty.rating.hash.datamodels.mapping.MappingCollection
.. autoclass:: cloudkitty.rating.hash.datamodels.mapping.MappingCollection
:members:
.. autotype:: cloudkitty.rating.hash.datamodels.threshold.Threshold
.. autoclass:: cloudkitty.rating.hash.datamodels.threshold.Threshold
:members:
.. autotype:: cloudkitty.rating.hash.datamodels.threshold.ThresholdCollection
.. autoclass:: cloudkitty.rating.hash.datamodels.threshold.ThresholdCollection
:members:
.. rest-controller:: cloudkitty.rating.hash.controllers.group:HashMapGroupsController
:webprefix: /v1/rating/module_config/hashmap/groups
.. autotype:: cloudkitty.rating.hash.datamodels.group.Group
.. autoclass:: cloudkitty.rating.hash.datamodels.group.Group
:members:
.. autotype:: cloudkitty.rating.hash.datamodels.group.GroupCollection
.. autoclass:: cloudkitty.rating.hash.datamodels.group.GroupCollection
:members:

4
api-ref/source/v1/rating/pyscripts.rst
View File

@@ -8,8 +8,8 @@ PyScripts Module REST API
.. rest-controller:: cloudkitty.rating.pyscripts.controllers.script:PyScriptsScriptsController
:webprefix: /v1/rating/module_config/pyscripts/scripts
.. autotype:: cloudkitty.rating.pyscripts.datamodels.script.Script
.. autoclass:: cloudkitty.rating.pyscripts.datamodels.script.Script
:members:
.. autotype:: cloudkitty.rating.pyscripts.datamodels.script.ScriptCollection
.. autoclass:: cloudkitty.rating.pyscripts.datamodels.script.ScriptCollection
:members:

24
api-ref/source/v1/v1.rst
View File

@@ -14,13 +14,13 @@ Collector
.. rest-controller:: cloudkitty.api.v1.controllers.collector:CollectorStateController
:webprefix: /v1/collector/states
.. autotype:: cloudkitty.api.v1.datamodels.collector.CollectorInfos
.. autoclass:: cloudkitty.api.v1.datamodels.collector.CollectorInfos
:members:
.. autotype:: cloudkitty.api.v1.datamodels.collector.ServiceToCollectorMapping
.. autoclass:: cloudkitty.api.v1.datamodels.collector.ServiceToCollectorMapping
:members:
.. autotype:: cloudkitty.api.v1.datamodels.collector.ServiceToCollectorMappingCollection
.. autoclass:: cloudkitty.api.v1.datamodels.collector.ServiceToCollectorMappingCollection
:members:
@@ -33,10 +33,10 @@ Info
.. rest-controller:: cloudkitty.api.v1.controllers.info:MetricInfoController
:webprefix: /v1/info/metric
.. autotype:: cloudkitty.api.v1.datamodels.info.CloudkittyMetricInfo
.. autoclass:: cloudkitty.api.v1.datamodels.info.CloudkittyMetricInfo
:members:
.. autotype:: cloudkitty.api.v1.datamodels.info.CloudkittyMetricInfoCollection
.. autoclass:: cloudkitty.api.v1.datamodels.info.CloudkittyMetricInfoCollection
:members:
.. rest-controller:: cloudkitty.api.v1.controllers.info:ServiceInfoController
@@ -55,16 +55,16 @@ Rating
.. rest-controller:: cloudkitty.api.v1.controllers.rating:RatingController
:webprefix: /v1/rating
.. autotype:: cloudkitty.api.v1.datamodels.rating.CloudkittyModule
.. autoclass:: cloudkitty.api.v1.datamodels.rating.CloudkittyModule
:members:
.. autotype:: cloudkitty.api.v1.datamodels.rating.CloudkittyModuleCollection
.. autoclass:: cloudkitty.api.v1.datamodels.rating.CloudkittyModuleCollection
:members:
.. autotype:: cloudkitty.api.v1.datamodels.rating.CloudkittyResource
.. autoclass:: cloudkitty.api.v1.datamodels.rating.CloudkittyResource
:members:
.. autotype:: cloudkitty.api.v1.datamodels.rating.CloudkittyResourceCollection
.. autoclass:: cloudkitty.api.v1.datamodels.rating.CloudkittyResourceCollection
:members:
@@ -84,11 +84,11 @@ Storage
.. rest-controller:: cloudkitty.api.v1.controllers.storage:DataFramesController
:webprefix: /v1/storage/dataframes
.. autotype:: cloudkitty.api.v1.datamodels.storage.RatedResource
.. autoclass:: cloudkitty.api.v1.datamodels.storage.RatedResource
:members:
.. autotype:: cloudkitty.api.v1.datamodels.storage.DataFrame
.. autoclass:: cloudkitty.api.v1.datamodels.storage.DataFrame
:members:
.. autotype:: cloudkitty.api.v1.datamodels.storage.DataFrameCollection
.. autoclass:: cloudkitty.api.v1.datamodels.storage.DataFrameCollection
:members: