openstack/python-ironicclient
Code Issues Proposed changes

Fix references to ironicclient classes and methods

Browse Source 
All links to classes and methods in this page were returning 404s. Use
:py:class: and :py:meth: to generate correct links instead.

Change-Id: I425546c6cb911f1eb0946d58826507116b01e36b
This commit is contained in:
Pierre Riteau 2021-10-18 15:38:42 +02:00
parent 6f1be0651b
commit e76c43b86d
1 changed files with 15 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/source/api_v1.rst
View File

@ -8,24 +8,26 @@ The ironicclient python API lets you access ironic, the OpenStack
Bare Metal Provisioning Service. Bare Metal Provisioning Service.
For example, to manipulate nodes, you interact with an For example, to manipulate nodes, you interact with an
`ironicclient.v1.node`_ object. :py:class:`ironicclient.v1.node.Node` object.
You obtain access to nodes via attributes of the You obtain access to nodes via attributes of the
`ironicclient.v1.client.Client`_ object. :py:class:`ironicclient.v1.client.Client` object.
Usage Usage
===== =====
Get a Client object Get a Client object
------------------- -------------------
First, create an `ironicclient.v1.client.Client`_ instance by passing your First, create an :py:class:`ironicclient.v1.client.Client` instance by passing
credentials to `ironicclient.client.get_client()`_. By default, the your credentials to :py:meth:`ironicclient.client.get_client()`. By default,
Bare Metal Provisioning system is configured so that only administrators the Bare Metal Provisioning system is configured so that only administrators
(users with 'admin' role) have access. (users with 'admin' role) have access.
.. note:: .. note::
Explicit instantiation of `ironicclient.v1.client.Client`_ may cause
errors since it doesn't verify provided arguments, using Explicit instantiation of :py:class:`ironicclient.v1.client.Client` may
`ironicclient.client.get_client()` is preferred way to get client object. cause errors since it doesn't verify provided arguments, using
:py:meth:`ironicclient.client.get_client()` is preferred way to get client
object.
There are two different sets of credentials that can be used:: There are two different sets of credentials that can be used::
@ -81,15 +83,16 @@ To create a client, you can use the API like so::
Perform ironic operations Perform ironic operations
------------------------- -------------------------
Once you have an ironic `Client`_, you can perform various tasks:: Once you have an :py:class:`ironicclient.v1.client.Client`, you can perform
various tasks::
>>> ironic.driver.list() # list of drivers >>> ironic.driver.list() # list of drivers
>>> ironic.node.list() # list of nodes >>> ironic.node.list() # list of nodes
>>> ironic.node.get(node_uuid) # information about a particular node >>> ironic.node.get(node_uuid) # information about a particular node
When the `Client`_ needs to propagate an exception, it will usually When the Client needs to propagate an exception, it will usually raise an
raise an instance subclassed from instance subclassed from
`ironicclient.exc.BaseException`_ or `ironicclient.exc.ClientException`_. :py:class:`ironicclient.common.apiclient.exceptions.ClientException`.
Refer to the modules themselves, for more details. Refer to the modules themselves, for more details.
@ -97,10 +100,3 @@ ironicclient Modules
==================== ====================
* :ref:`modindex` * :ref:`modindex`
.. _ironicclient.v1.node: api/ironicclient.v1.node.html#ironicclient.v1.node.Node
.. _ironicclient.v1.client.Client: api/ironicclient.v1.client.html#ironicclient.v1.client.Client
.. _Client: api/ironicclient.v1.client.html#ironicclient.v1.client.Client
.. _ironicclient.client.get_client(): api/ironicclient.client.html#ironicclient.client.get_client
.. _ironicclient.exc.BaseException: api/ironicclient.exc.html#ironicclient.exc.BaseException
.. _ironicclient.exc.ClientException: api/ironicclient.exc.html#ironicclient.exc.ClientException