summaryrefslogtreecommitdiff
path: root/api-ref/source
diff options
context:
space:
mode:
Diffstat (limited to 'api-ref/source')
-rw-r--r--api-ref/source/baremetal-api-v1-misc.inc4
-rw-r--r--api-ref/source/parameters.yaml7
2 files changed, 11 insertions, 0 deletions
diff --git a/api-ref/source/baremetal-api-v1-misc.inc b/api-ref/source/baremetal-api-v1-misc.inc
index 5bbc2e9be..078b956fb 100644
--- a/api-ref/source/baremetal-api-v1-misc.inc
+++ b/api-ref/source/baremetal-api-v1-misc.inc
@@ -95,6 +95,9 @@ Normal response codes: 202
Error response codes: 400 404
+.. versionadded:: 1.36 ``agent_version`` parameter for passing the version of
+ the Ironic Python Agent to Ironic during heartbeat
+
Request
-------
@@ -102,3 +105,4 @@ Request
- node_ident: node_ident
- callback_url: callback_url
+ - agent_version: agent_version
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 8c201ac77..ac403237d 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -87,6 +87,13 @@ volume_target_id:
required: true
type: string
+agent_version:
+ description: |
+ The version of the ironic-python-agent ramdisk, sent back to the Bare Metal
+ service and stored during provisioning.
+ in: query
+ required: true
+ type: string
callback_url:
description: |
The URL of an active ironic-python-agent ramdisk, sent back to the Bare