From 6e7840842a9fd314554ae9353ded1869c19787ad Mon Sep 17 00:00:00 2001 From: Brian Curtin Date: Thu, 16 Feb 2017 15:58:21 -0500 Subject: [PATCH] Implement metric docs This change introduces metric docs. There is only one method in the proxy as of right now, so that was easy. Change-Id: Ica327f27b26e5dd4b6744566eb09ea81a6e9583e --- doc/source/users/index.rst | 1 + doc/source/users/proxies/metric.rst | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 doc/source/users/proxies/metric.rst diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst index fbac4aafe..811eff398 100644 --- a/doc/source/users/index.rst +++ b/doc/source/users/index.rst @@ -80,6 +80,7 @@ but listed below are the ones provided by this SDK by default. Image v2 Key Manager Network + Metric Object Store Orchestration Telemetry diff --git a/doc/source/users/proxies/metric.rst b/doc/source/users/proxies/metric.rst new file mode 100644 index 000000000..3abd98f9d --- /dev/null +++ b/doc/source/users/proxies/metric.rst @@ -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