openstack/ironic-python-agent
Code Issues Proposed changes

[doc] Clarify Step return values

Browse Source 
Clarifying what we require for a return value in a cleaning step;
basically not much.

Change-Id: I28c26d5b2d32d7af8d97900eb029741c8dbb166f
This commit is contained in:
Jay Faulkner 2024-08-19 08:34:08 -07:00
parent 4cea26f185
commit b173ce9202
1 changed files with 7 additions and 0 deletions
Show Stats 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.