diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index b5365832b0..ca2c78b243 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -368,8 +368,8 @@ clean_step: clean_steps: description: | An ordered list of cleaning steps that will be performed on the node. A - cleaning step is a dictionary with required keys ‘interface’ and ‘step’, and - optional key ‘args’. If specified, the value for ‘args’ is a keyword variable + cleaning step is a dictionary with required keys 'interface' and 'step', and + optional key 'args'. If specified, the value for 'args' is a keyword variable argument dictionary that is passed to the cleaning step method. in: body required: false diff --git a/ironic/drivers/base.py b/ironic/drivers/base.py index 7412f88c2b..79eefb0e7f 100644 --- a/ironic/drivers/base.py +++ b/ironic/drivers/base.py @@ -1182,9 +1182,9 @@ def _validate_argsinfo(argsinfo): :param argsinfo: a dictionary of keyword arguments where key is the name of the argument and value is a dictionary as follows:: - ‘description’: . Required. This should include + 'description': . Required. This should include possible values. - ‘required’: Boolean. Optional; default is False. True if this + 'required': Boolean. Optional; default is False. True if this argument is required. If so, it must be specified in the clean request; false if it is optional. :raises InvalidParameterValue: if any of the arguments are invalid @@ -1276,9 +1276,9 @@ def clean_step(priority, abortable=False, argsinfo=None): :param argsinfo: a dictionary of keyword arguments where key is the name of the argument and value is a dictionary as follows:: - ‘description’: . Required. This should include + 'description': . Required. This should include possible values. - ‘required’: Boolean. Optional; default is False. True if this + 'required': Boolean. Optional; default is False. True if this argument is required. If so, it must be specified in the clean request; false if it is optional. :raises InvalidParameterValue: if any of the arguments are invalid