openstack/ironic
Code Issues Proposed changes
be242dc13b
ironic/api-ref/source/index.rst

38 lines
1.4 KiB
ReStructuredText
Raw Normal View History

Migrate api-ref into our tree Per this email[0], it's time to migrate our API docs into our tree. This copies the sphinx extension from nova into our tree as well, which will be later split into its own python module. At that time we can cut over to the module and drop it from our tree. The conf.py and the tox environment are also cribbed from nova. [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Change-Id: I683cc4d6459d77c42951a06247b6f9ff8f8456bd
2016-05-03 13:24:10 -04:00
:tocdepth: 2
================
Bare Metal API
================
.. rest_expand_all::
Update the api-ref documentation for Root and Nodes This updates the API root documentation, which was non-existent, and the Node documentation significantly, replacing many of the samples and adding more verbiage to each property. It's not perfect, but this is vastly more correct than the current docs. Change-Id: Iaeb1c80ac0655fc0d73fa495ed43e3c02b345495
2016-05-04 17:32:52 -07:00
.. include:: baremetal-api-versions.inc
Migrate api-ref into our tree Per this email[0], it's time to migrate our API docs into our tree. This copies the sphinx extension from nova into our tree as well, which will be later split into its own python module. At that time we can cut over to the module and drop it from our tree. The conf.py and the tox environment are also cribbed from nova. [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Change-Id: I683cc4d6459d77c42951a06247b6f9ff8f8456bd
2016-05-03 13:24:10 -04:00
.. include:: baremetal-api-v1-nodes.inc
Update the api-ref documentation for Root and Nodes This updates the API root documentation, which was non-existent, and the Node documentation significantly, replacing many of the samples and adding more verbiage to each property. It's not perfect, but this is vastly more correct than the current docs. Change-Id: Iaeb1c80ac0655fc0d73fa495ed43e3c02b345495
2016-05-04 17:32:52 -07:00
.. include:: baremetal-api-v1-node-management.inc
.. include:: baremetal-api-v1-node-passthru.inc
Add node traits to API reference The node traits API was added in API microversion 1.37. Change-Id: I8c48f2e7662ae9641ec823dc3802d5979a7ea03e Partial-Bug: #1722194
2018-01-22 11:32:02 +00:00
.. include:: baremetal-api-v1-nodes-traits.inc
Add VIFs attach/detach to api-ref This patch updates api-ref documentation with VIF attach/detach changes that were added in API microversion 1.28. Closes-Bug: #1582188 Change-Id: I2950a1a356ccb3feb7a4c6335eb95a7a52b3266a
2016-12-23 12:34:58 +00:00
.. include:: baremetal-api-v1-nodes-vifs.inc
Add api-ref for indicators API Change-Id: Ie40f585b26efdd70b88f2e642698eb9e988e3d97 Story: 2007745 Task: 39923
2020-06-01 12:17:55 +02:00
.. include:: baremetal-api-v1-indicators.inc
Add portgroup to api-ref This patch updates api-ref documentations to reflect portgroup changes. Related-Bug: #1618754 Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com> Change-Id: Id34344df9d3e68efe891c2be4a0b362be6557202
2016-11-04 18:04:33 +02:00
.. include:: baremetal-api-v1-portgroups.inc
.. include:: baremetal-api-v1-nodes-portgroups.inc
Migrate api-ref into our tree Per this email[0], it's time to migrate our API docs into our tree. This copies the sphinx extension from nova into our tree as well, which will be later split into its own python module. At that time we can cut over to the module and drop it from our tree. The conf.py and the tox environment are also cribbed from nova. [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Change-Id: I683cc4d6459d77c42951a06247b6f9ff8f8456bd
2016-05-03 13:24:10 -04:00
.. include:: baremetal-api-v1-ports.inc
Update the api-ref documentation for Ports This updates the API documentation for the Ports resource class, replacing many of the samples and adding more verbiage to each property. It's not perfect, but this is vastly more correct than the current docs. Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com> Change-Id: I559ef1e921aa8e2f2f1a8bd6ed18e0a39ecc4687
2016-05-05 16:22:45 -07:00
.. include:: baremetal-api-v1-nodes-ports.inc
Add portgroup to api-ref This patch updates api-ref documentations to reflect portgroup changes. Related-Bug: #1618754 Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com> Change-Id: Id34344df9d3e68efe891c2be4a0b362be6557202
2016-11-04 18:04:33 +02:00
.. include:: baremetal-api-v1-portgroups-ports.inc
Add API for volume resources to api-ref This patch adds API for volume resources to api-ref. Partial-Bug: 1526231 Change-Id: I986860cffd344f5cea9f8f5a2f845f77bf6e9e54
2017-07-04 14:47:13 +09:00
.. include:: baremetal-api-v1-volume.inc
.. include:: baremetal-api-v1-nodes-volume.inc
Update the api-ref documentation for Root and Nodes This updates the API root documentation, which was non-existent, and the Node documentation significantly, replacing many of the samples and adding more verbiage to each property. It's not perfect, but this is vastly more correct than the current docs. Change-Id: Iaeb1c80ac0655fc0d73fa495ed43e3c02b345495
2016-05-04 17:32:52 -07:00
.. include:: baremetal-api-v1-drivers.inc
Update the api-ref documentation for Drivers This updates the API documentation for the Drivers resource class, replacing many of the samples and adding more verbiage to each property. It's not perfect, but this is vastly more correct than the current docs. Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com> Change-Id: Ibe045bea539b8fd2f02d7be37e09cc74f09b8df1
2016-05-06 14:53:55 -07:00
.. include:: baremetal-api-v1-driver-passthru.inc
Add documentation for BIOS settings Update api-ref documentation, to add the BIOS settings. Change-Id: Ic592b5fa39f0d19d5676906ecd5c8fcbebf8e25f
2018-07-24 13:40:44 +02:00
.. include:: baremetal-api-v1-nodes-bios.inc
api-ref for nodes/{node_ident}/firmware Change-Id: Ica87a7f4bc3a2cce679155200452d7b915d3f0f5
2023-09-29 14:51:10 -03:00
.. include:: baremetal-api-v1-nodes-firmware.inc
Expose conductors: api-ref This patch updates API reference to contain the changes made by the feature of exposing conductors. Story: 1724474 Task: 28064 Change-Id: I47dbea2cda1cc0ad73786fe3fe9b80850e1cf289
2018-12-05 15:00:05 +08:00
.. include:: baremetal-api-v1-conductors.inc
Allocation API: reference documentation Change-Id: I48f20f0b96931a17c477b9687b0ee963cb7b8879 Story: #2004341 Task: #29574
2019-02-20 12:16:22 +01:00
.. include:: baremetal-api-v1-allocation.inc
.. include:: baremetal-api-v1-node-allocation.inc
Deploy Templates: API reference Change-Id: I14716e6023dd09096e17e60c7d02230ecb3e7150 Story: 1722275 Task: 28680
2019-03-11 14:23:09 +00:00
.. include:: baremetal-api-v1-deploy-templates.inc
API endpoints to get node history Adds API for retrieving node history events via a node. Includes pagination and limitation of the response set. Story: 2002980 Tas: 42961 Change-Id: I22a92fa6c30d721f6a5dd0670b2e0a9cf76ad7b1
2021-08-07 21:31:51 -07:00
.. include:: baremetal-api-v1-nodes-history.inc
Add missing include for inventory API reference Also fix up the title and make sure the linter checks API ref files. Change-Id: I360fd4fab699e732ac03dc07faab33e18fe2bf13
2023-02-23 18:38:19 +01:00
.. include:: baremetal-api-v1-nodes-inventory.inc
API support for CRUD node.shard - Basic support and testing for CRUD for node.shard. - Policy checking for update node.shard. - New API endpoint: GET /v1/shards - Policy checking for GET /v1/shards - Support for querying for nodes in a list of shards Story: 2010378 Task: 46624 Change-Id: I385594339028c20cfc83fdcc4cbbec107efdacff
2022-11-30 15:28:29 -08:00
.. include:: baremetal-api-v1-shards.inc
Allocation API: reference documentation Change-Id: I48f20f0b96931a17c477b9687b0ee963cb7b8879 Story: #2004341 Task: #29574
2019-02-20 12:16:22 +01:00
.. NOTE(dtantsur): keep chassis close to the end since it's semi-deprecated
.. include:: baremetal-api-v1-chassis.inc
.. NOTE(dtantsur): keep misc last, since it covers internal API
.. include:: baremetal-api-v1-misc.inc
Copy Permalink