openstack/ironic
Code Issues Proposed changes
Files
50a2fee61e0248a0113231b153dfdfb04f8db12b
ironic/api-ref/source/samples
History
Jay Faulkner bc463ebcbb Add node.instance_name 
This adds node.instance_name as a top level field

Additionally, to provide forwards-compatability for nova clients,
we will automatically set node.instance_name if
node.instance_info.display_name is being set.

Tested the following in devstack, using manual CURL api calls:

 - Viewing an instance_name via GET /v1/nodes/node-name
 - Adding an instance_name
 - Clearing instance name on undeploy
 - Setting an instance_name via PATCH /v1/nodes/node-name
 - Setting a instance_info/display_name and validating it sets instance_name
 - Setting a instance_info/display_name when instance_name already exists and
   validating it DOES NOT OVERRIDE existing instance_name
 - node.instance_name not returned for API version < our micro version
 - querying /v1/nodes with ?instance_name=somename
 - (cid) Sort of fully tested integrated with nova by observing CI logs
 - (jayf) Added missing comments around API versions, and added a reminder
   comment

Generated-By: Claude code
Change-Id: Ic24b2e8dbe88c59f0df52a0f5581d48492ba8cd7
Signed-off-by: Afonne-CID <afonnepaulc@gmail.com>
Signed-off-by: Jay Faulkner <jay@jvf.cc>
2025-11-12 13:34:51 +01:00
..
allocation-create-request-2.json
Allocation API: reference documentation
2019-02-26 10:16:25 +01:00
allocation-create-request.json
Allocation API: reference documentation
2019-02-26 10:16:25 +01:00
allocation-create-response.json
Add owner to allocations and create relevant policies
2019-12-10 19:00:33 +00:00
allocation-show-response.json
Add owner to allocations and create relevant policies
2019-12-10 19:00:33 +00:00
allocation-update-request.json
Add api-ref for allocation update
2019-06-06 09:32:39 +05:30
allocation-update-response.json
Add owner to allocations and create relevant policies
2019-12-10 19:00:33 +00:00
allocations-list-response.json
Add owner to allocations and create relevant policies
2019-12-10 19:00:33 +00:00
api-root-response.json
There is no aim, we do deploy/manage baremetal.
2021-10-15 15:52:58 -07:00
api-v1-root-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
chassis-create-request.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
chassis-list-details-response.json
Update regenerate-samples.sh api-ref script
2016-12-26 14:21:18 +00:00
chassis-list-response.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
chassis-show-response.json
Update regenerate-samples.sh api-ref script
2016-12-26 14:21:18 +00:00
chassis-update-request.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
chassis-update-response.json
Update regenerate-samples.sh api-ref script
2016-12-26 14:21:18 +00:00
conductor-list-details-response.json
Expose conductors: api-ref
2019-02-12 07:02:09 -08:00
conductor-list-response.json
Expose conductors: api-ref
2019-02-12 07:02:09 -08:00
conductor-show-response.json
Expose conductors: api-ref
2019-02-12 07:02:09 -08:00
deploy-template-create-request.json
Deploy Templates: API reference
2019-03-12 15:43:12 +00:00
deploy-template-create-response.json
Deploy Templates: API reference
2019-03-12 15:43:12 +00:00
deploy-template-detail-response.json
Deploy Templates: API reference
2019-03-12 15:43:12 +00:00
deploy-template-list-response.json
Deploy Templates: API reference
2019-03-12 15:43:12 +00:00
deploy-template-show-response.json
Deploy Templates: API reference
2019-03-12 15:43:12 +00:00
deploy-template-update-request.json
Deploy Templates: API reference
2019-03-12 15:43:12 +00:00
deploy-template-update-response.json
Deploy Templates: API reference
2019-03-12 15:43:12 +00:00
driver-get-response.json
[api-ref] Add firmware fields to driver API
2023-11-01 09:49:05 +13:00
driver-logical-disk-properties-response.json
Fix quotes in documentation and schema description
2017-07-03 19:32:26 +03:00
driver-property-response.json
Introduce configuration option [ipmi]ipmi_disable_timeout
2018-12-10 14:04:02 -08:00
drivers-list-detail-response.json
[api-ref] Add firmware fields to driver API
2023-11-01 09:49:05 +13:00
drivers-list-response.json
Update api-ref for dynamic drivers
2017-02-09 19:51:03 +00:00
inspection-rule-create-request.json
doc: Migrate Inspection Rules
2025-03-27 13:14:15 +01:00
inspection-rule-create-response.json
doc: Migrate Inspection Rules
2025-03-27 13:14:15 +01:00
inspection-rule-detail-response.json
doc: Migrate Inspection Rules
2025-03-27 13:14:15 +01:00
inspection-rule-list-response.json
doc: Migrate Inspection Rules
2025-03-27 13:14:15 +01:00
inspection-rule-show-response.json
doc: Migrate Inspection Rules
2025-03-27 13:14:15 +01:00
inspection-rule-update-request.json
doc: Migrate Inspection Rules
2025-03-27 13:14:15 +01:00
inspection-rule-update-response.json
doc: Migrate Inspection Rules
2025-03-27 13:14:15 +01:00
lookup-node-response.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
node-bios-detail-response.json
Make all API samples valid JSON
2024-10-29 14:55:44 -07:00
node-bios-list-details-response.json
Make all API samples valid JSON
2024-10-29 14:55:44 -07:00
node-bios-list-response.json
Include bios registry fields in bios API
2021-05-27 12:15:20 -04:00
node-create-request-classic.json
Allocation API: reference documentation
2019-02-26 10:16:25 +01:00
node-create-request-dynamic.json
Allocation API: reference documentation
2019-02-26 10:16:25 +01:00
node-create-response.json
Add node.instance_name
2025-11-12 13:34:51 +01:00
node-firmware-components-list-response.json
Firmware Interface
2023-07-11 07:39:15 -03:00
node-get-boot-device-response.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
node-get-state-response.json
Add boot_mode and secure_boot to node object and expose in api
2021-07-08 15:04:15 +02:00
node-get-supported-boot-devices-response.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
node-history-list-response.json
API endpoints to get node history
2021-09-15 10:54:11 -07:00
node-indicators-get-state-response.json
Add api-ref for indicators API
2020-06-19 09:05:08 +02:00
node-indicators-list-response.json
Make all API samples valid JSON
2024-10-29 14:55:44 -07:00
node-indicators-set-state.json
Add api-ref for indicators API
2020-06-19 09:05:08 +02:00
node-inject-nmi.json
Add Inject NMI to api-ref
2017-01-30 13:59:56 +09:00
node-inventory-response.json
Remove all references to the "cpus" property
2023-03-28 11:53:26 +02:00
node-maintenance-request.json
Update the api-ref documentation for Root and Nodes
2016-05-20 08:35:29 -07:00
node-port-detail-response.json
Add a new 'category' field to the Port object
2025-08-18 21:59:33 -05:00
node-port-list-response.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
node-portgroup-detail-response.json
Update regenerate-samples.sh api-ref script
2016-12-26 14:21:18 +00:00
node-portgroup-list-response.json
Add portgroup to api-ref
2016-11-16 12:13:53 +02:00
node-set-active-state-deploy-steps.json
Add 'deploy steps' parameter for provisioning API
2021-02-03 11:47:53 -05:00
node-set-active-state.json
Update the api-ref documentation for Root and Nodes
2016-05-20 08:35:29 -07:00
node-set-available-state.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
node-set-boot-device.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
node-set-boot-mode-bios.json
Add api endpoints for changing boot_mode and secure_boot state
2021-08-23 19:38:58 +02:00
node-set-boot-mode-uefi.json
Add api endpoints for changing boot_mode and secure_boot state
2021-08-23 19:38:58 +02:00
node-set-clean-state.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
node-set-manage-state.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
node-set-power-off.json
Update the api-ref documentation for Root and Nodes
2016-05-20 08:35:29 -07:00
node-set-provision-state.json
Follow up to the runbooks change (#922142)
2024-08-13 11:52:36 +01:00
node-set-raid-request.json
Update the api-ref documentation for Root and Nodes
2016-05-20 08:35:29 -07:00
node-set-secure-boot-off.json
Add api endpoints for changing boot_mode and secure_boot state
2021-08-23 19:38:58 +02:00
node-set-secure-boot-on.json
Add api endpoints for changing boot_mode and secure_boot state
2021-08-23 19:38:58 +02:00
node-set-service-state.json
Follow up to the runbooks change (#922142)
2024-08-13 11:52:36 +01:00
node-set-soft-power-off.json
Remove single quoted strings in json sample
2017-05-17 23:50:09 +07:00
node-set-traits-request.json
Add node traits to API reference
2018-01-25 01:36:54 +00:00
node-show-response.json
Add node.instance_name
2025-11-12 13:34:51 +01:00
node-traits-list-response.json
Add node traits to API reference
2018-01-25 01:36:54 +00:00
node-update-driver-info-request.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
node-update-driver-info-response.json
Add node.instance_name
2025-11-12 13:34:51 +01:00
node-update-driver.json
Update api-ref for v1.22
2016-08-21 11:43:30 -07:00
node-validate-response.json
Add api-ref and ironic state documentation for rescue
2018-01-31 04:08:07 -05:00
node-vendor-passthru-response.json
Remove remaining vendor passthru lookup/heartbeat
2017-05-17 15:03:39 -04:00
node-vif-attach-request.json
Add VIFs attach/detach to api-ref
2017-01-18 18:47:38 +00:00
node-vif-list-response.json
Add VIFs attach/detach to api-ref
2017-01-18 18:47:38 +00:00
node-vmedia-attach-request.json
Generic API for attaching/detaching virtual media
2023-11-23 09:55:09 +01:00
node-volume-connector-detail-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
node-volume-connector-list-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
node-volume-list-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
node-volume-target-detail-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
node-volume-target-list-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
nodes-list-details-response.json
Add node.instance_name
2025-11-12 13:34:51 +01:00
nodes-list-response.json
Update api-ref for dynamic drivers
2017-02-09 19:51:03 +00:00
port-create-request.json
Add a new 'category' field to the Port object
2025-08-18 21:59:33 -05:00
port-create-response.json
Add a new 'category' field to the Port object
2025-08-18 21:59:33 -05:00
port-list-detail-response.json
Add a new 'category' field to the Port object
2025-08-18 21:59:33 -05:00
port-list-response.json
Fix typos of filename in api-ref
2017-03-14 19:35:53 +08:00
port-update-request.json
Update the api-ref documentation for Ports
2016-05-31 18:11:52 +03:00
port-update-response.json
Add a new 'category' field to the Port object
2025-08-18 21:59:33 -05:00
portgroup-create-request.json
Add portgroup to api-ref
2016-11-16 12:13:53 +02:00
portgroup-create-response.json
Add a new 'category' field to the Portgroup object
2025-11-04 12:44:01 -08:00
portgroup-list-detail-response.json
Add a new 'category' field to the Portgroup object
2025-11-04 12:44:01 -08:00
portgroup-list-response.json
Add portgroup to api-ref
2016-11-16 12:13:53 +02:00
portgroup-port-detail-response.json
Expose is_smartnic in port API
2019-02-10 12:10:00 +02:00
portgroup-port-list-response.json
Add portgroup to api-ref
2016-11-16 12:13:53 +02:00
portgroup-update-request.json
Add portgroup to api-ref
2016-11-16 12:13:53 +02:00
portgroup-update-response.json
Add a new 'category' field to the Portgroup object
2025-11-04 12:44:01 -08:00
runbook-create-request.json
Follow up to the runbooks change (#922142)
2024-08-13 11:52:36 +01:00
runbook-create-response.json
Follow up to the runbooks change (#922142)
2024-08-13 11:52:36 +01:00
runbook-detail-response.json
Follow up to the runbooks change (#922142)
2024-08-13 11:52:36 +01:00
runbook-list-response.json
Follow up to the runbooks change (#922142)
2024-08-13 11:52:36 +01:00
runbook-show-response.json
Follow up to the runbooks change (#922142)
2024-08-13 11:52:36 +01:00
runbook-update-request.json
Follow up to the runbooks change (#922142)
2024-08-13 11:52:36 +01:00
runbook-update-response.json
Follow up to the runbooks change (#922142)
2024-08-13 11:52:36 +01:00
shards-list-response.json
Make all API samples valid JSON
2024-10-29 14:55:44 -07:00
volume-connector-create-request.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-connector-create-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-connector-list-detail-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-connector-list-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-connector-update-request.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-connector-update-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-list-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-target-create-request.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-target-create-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-target-list-detail-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-target-list-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-target-update-request.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00
volume-target-update-response.json
Add API for volume resources to api-ref
2017-08-02 12:46:36 +00:00