summaryrefslogtreecommitdiff
path: root/doc/source/api_v1.rst
Commit message (Collapse)AuthorAgeFilesLines
* Fix references to ironicclient classes and methodsPierre Riteau2021-10-181-19/+15
| | | | | | | 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
* Follow the new PTI for document buildNguyen Hai2018-04-191-5/+1
| | | | | | | | | | | | - Follow new PTI for docs build - Add sphinxcontrib.apidoc to replace pbr autodoc REF: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: I76e8ec019ef30fdc2d34a25a99e849407f586459
* Update 'Usage' section in 'doc/source/api_v1.rst'ya.wang2018-02-221-0/+7
| | | | | | | | | | | When I want to get the client with 'Using Identity Service (keystone) credentials' section, it will throw errors.(usually http 400) After testing it is found that two variables aare missing: - os_user_domain_name - os_project_domain_name Now added them to the document. Change-Id: Ibdebc7cf0fc017b7eeb378b022ce5cffcd943fb2
* Change tenant to project in docs and unit testsKyrylo Romanenko2017-02-021-1/+1
| | | | | | | | | | Change os_tenant_name to os_project_name in documentation, client and shell unit tests. This is follow-up change augmenting the patch https://review.openstack.org/#/c/408235/ for consistency. Change-Id: Iaea3ddc71dadc2991e56667988df82aa1cfaf525 Related-Bug: #1646837
* Typo fix: prefered => preferredAnh Tran2017-01-231-1/+1
| | | | Change-Id: I7d34d595b0f192d8531a6a85f73c6911c864c36d
* Merge "Fail with more meaningful error while creating client"Jenkins2016-08-181-1/+6
|\
| * Fail with more meaningful error while creating clientAnton Arefiev2016-08-151-1/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | Parameter 'endpoint' in v1 client object is mandatory if os_ironic_api_version isn't specified. It's used to fetch version from cache[1] and as endpoint override in session client[2]. But since it passed via *args, it could be missing, and creation fails with IndexError. [1] https://github.com/openstack/python-ironicclient/blob/master/ironicclient/v1/client.py#L42 [2] https://github.com/openstack/python-ironicclient/blob/master/ironicclient/common/http.py#L595 Change-Id: I0310f748a1254dd7e54d93f913cff53aadaff16b
* | Fix Quick-start example syntax.Vasyl Saienko2016-07-131-1/+1
|/ | | | | | This patch fixes syntax of example provided by documentation. Change-Id: I2f6a5361a2dd4af1357a99e470eef2eed9a6b4cd
* Use doc8 style checkerRuby Loo2015-09-301-2/+4
| | | | | | | | | | | This uses the doc8 style checker to check that document files conform to certain requirements, as documented at https://pypi.python.org/pypi/doc8. Some files were modified because they had lines that were longer than 79 characters. Change-Id: I94e081e197898359676821cfcf8cb1133ed28bc5
* Fix Python Ironic Client DocumentationDiego de Lima Pereira2015-02-131-2/+2
| | | | | | | | | In the 'ironicclient Python API' page, the credential section has a little mistake in the example. It's missing "," in the first line and a '}' in the last. You can see it at http://docs.openstack.org/developer/python-ironicclient/api_v1.html Change-Id: I195f46ca7261390b0d6321bc6bdd7e8d0908af40
* Fix sphinx warningsDavid Shrewsbury2014-11-141-1/+1
| | | | | | | | | Getting rid of a couple of warnings that are generated during the documentation build. Closes-Bug: #1392780 Change-Id: I2ebc8f1ec49ff80331077a653f0e73c988153898
* Adds documentation for ironicclient APIRuby Loo2014-04-161-0/+96
Adds some documentation on how to use the ironicclient API. Describes how to get a client object and has examples of a few ironic operations. The ironicclient modules are listed. Change-Id: Ic7c739fb5722b40c308b90c27178d937cad41028 Partial-Bug: #1300990
View Lorry Controller Status