diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst index 6d589dcad..b3879dc81 100644 --- a/doc/source/users/index.rst +++ b/doc/source/users/index.rst @@ -98,6 +98,7 @@ The following services have exposed *Resource* classes. Database Network Object Store + Telemetry Volume Low-Level Classes diff --git a/doc/source/users/resources/telemetry/index.rst b/doc/source/users/resources/telemetry/index.rst new file mode 100644 index 000000000..f377bc749 --- /dev/null +++ b/doc/source/users/resources/telemetry/index.rst @@ -0,0 +1,13 @@ +Telemetry Resources +=================== + +.. toctree:: + :maxdepth: 1 + + v2/alarm + v2/alarm_change + v2/capability + v2/meter + v2/resource + v2/sample + v2/statistics diff --git a/doc/source/users/resources/telemetry/v2/alarm.rst b/doc/source/users/resources/telemetry/v2/alarm.rst new file mode 100644 index 000000000..3109d90e5 --- /dev/null +++ b/doc/source/users/resources/telemetry/v2/alarm.rst @@ -0,0 +1,12 @@ +openstack.telemetry.v2.alarm +============================ + +.. automodule:: openstack.telemetry.v2.alarm + +The Alarm Class +--------------- + +The ``Alarm`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.telemetry.v2.alarm.Alarm + :members: diff --git a/doc/source/users/resources/telemetry/v2/alarm_change.rst b/doc/source/users/resources/telemetry/v2/alarm_change.rst new file mode 100644 index 000000000..55c8d1e0c --- /dev/null +++ b/doc/source/users/resources/telemetry/v2/alarm_change.rst @@ -0,0 +1,12 @@ +openstack.telemetry.v2.alarm_change +=================================== + +.. automodule:: openstack.telemetry.v2.alarm_change + +The AlarmChange Class +--------------------- + +The ``AlarmChange`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.telemetry.v2.alarm_change.AlarmChange + :members: diff --git a/doc/source/users/resources/telemetry/v2/capability.rst b/doc/source/users/resources/telemetry/v2/capability.rst new file mode 100644 index 000000000..c17edd501 --- /dev/null +++ b/doc/source/users/resources/telemetry/v2/capability.rst @@ -0,0 +1,12 @@ +openstack.telemetry.v2.capability +================================= + +.. automodule:: openstack.telemetry.v2.capability + +The Capability Class +-------------------- + +The ``Capability`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.telemetry.v2.capability.Capability + :members: diff --git a/doc/source/users/resources/telemetry/v2/meter.rst b/doc/source/users/resources/telemetry/v2/meter.rst new file mode 100644 index 000000000..b38bc5b6b --- /dev/null +++ b/doc/source/users/resources/telemetry/v2/meter.rst @@ -0,0 +1,12 @@ +openstack.telemetry.v2.meter +============================ + +.. automodule:: openstack.telemetry.v2.meter + +The Meter Class +---------------- + +The ``Meter`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.telemetry.v2.meter.Meter + :members: diff --git a/doc/source/users/resources/telemetry/v2/resource.rst b/doc/source/users/resources/telemetry/v2/resource.rst new file mode 100644 index 000000000..f3b33887d --- /dev/null +++ b/doc/source/users/resources/telemetry/v2/resource.rst @@ -0,0 +1,12 @@ +openstack.telemetry.v2.resource +=============================== + +.. automodule:: openstack.telemetry.v2.resource + +The Resource Class +------------------ + +The ``Resource`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.telemetry.v2.resource.Resource + :members: diff --git a/doc/source/users/resources/telemetry/v2/sample.rst b/doc/source/users/resources/telemetry/v2/sample.rst new file mode 100644 index 000000000..f2430df27 --- /dev/null +++ b/doc/source/users/resources/telemetry/v2/sample.rst @@ -0,0 +1,12 @@ +openstack.telemetry.v2.sample +============================= + +.. automodule:: openstack.telemetry.v2.sample + +The Sample Class +---------------- + +The ``Sample`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.telemetry.v2.sample.Sample + :members: diff --git a/doc/source/users/resources/telemetry/v2/statistics.rst b/doc/source/users/resources/telemetry/v2/statistics.rst new file mode 100644 index 000000000..7e1e6b8a5 --- /dev/null +++ b/doc/source/users/resources/telemetry/v2/statistics.rst @@ -0,0 +1,12 @@ +openstack.telemetry.v2.statistics +================================= + +.. automodule:: openstack.telemetry.v2.statistics + +The Statistics Class +-------------------- + +The ``Statistics`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.telemetry.v2.statistics.Statistics + :members: