openstack/ironic-python-agent
Code Issues Proposed changes

Merge "[doc] Clarify Step return values"

Browse Source
This commit is contained in:
Zuul
2024-09-09 16:44:28 +00:00
committed by Gerrit Code Review
parent ab99f36baa b173ce9202
commit 6d743ad4ba
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/contributor/hardware_managers.rst
View File

@@ -114,6 +114,13 @@ message, and no further managers will be called. An example step:
else: else:
raise errors.IncompatibleHardwareMethodError() raise errors.IncompatibleHardwareMethodError()
.. note::
If creating a new step, the value returned must be serializable into an
API response and log message. If replacing an existing step, you should
return a response of the same type and style of the upstream step.
If the step has args, you need to add them to argsinfo and provide the If the step has args, you need to add them to argsinfo and provide the
function with extra parameters. function with extra parameters.