openstack/openstacksdk
Code Issues Proposed changes

Merge "Implement metric docs"

Browse Source
This commit is contained in:
Jenkins 2017-02-28 14:28:50 +00:00 committed by Gerrit Code Review
commit adfbf65c14
2 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/users/index.rst
View File

@ -84,6 +84,7 @@ but listed below are the ones provided by this SDK by default.
Message v1 <proxies/message_v1>
Message v2 <proxies/message_v2>
Network <proxies/network>
Metric <proxies/metric>
Object Store <proxies/object_store>
Orchestration <proxies/orchestration>
Telemetry <proxies/telemetry>

18
doc/source/users/proxies/metric.rst Normal file
View File

@ -0,0 +1,18 @@
Metric API
==========
.. automodule:: openstack.metric.v1._proxy
The Metric Class
----------------
The metric high-level interface is available through the ``metric``
member of a :class:`~openstack.connection.Connection` object. The
``metric`` member will only be added if the service is detected.
Capability Operations
^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: openstack.metric.v1._proxy.Proxy
.. automethod:: openstack.metric.v1._proxy.Proxy.capabilities