[openstack-dev] [nova] Inconsistency of parameter type in Nova API Reference

Takashi Natsume natsume.takashi at lab.ntt.co.jp
Thu Jan 12 09:27:04 UTC 2017


On 2017/01/10 20:35, Sean Dague wrote:
> On 01/10/2017 01:39 AM, Takashi Natsume wrote:
>> Hi Nova developers.
>>
>> In Nova API Reference(*1),
>> the following parameters' values are 'null' in HTTP request body samples.
>> And their parameter types are defined as 'string'.
>>
>> * 'confirmResize' parameter in "Confirm Resized Server (confirmResize
>> Action)"
>> * 'lock' parameter in "Lock Server (lock Action)"
>> * 'pause' parameter in "Pause Server (pause Action)"
>> * 'resume' parameter in "Resume Suspended Server (resume Action)"
>> * 'revertResize' parameter in "Revert Resized Server (revertResize Action)"
>> * 'os-start' parameter in "Start Server (os-start Action)"
>> * 'os-stop' parameter in "Stop Server (os-stop Action)"
>> * 'suspend' parameter in "Suspend Server (suspend Action)"
>>
>> On the other hand,
>> the following parameter's value is 'null' in the HTTP request body sample.
>> But the parameter type is defined as 'none'.
>>
>> * 'trigger_crash_dump' in "Trigger Crash Dump In Server"
>>
>> IMO, there is inconsistency of parameter types.
>> Should they be unified as 'none'?
>
> +1. 'none' seem appropriate here and not confuse this with strings.
>
> 	-Sean

Thank you for your reply.
I will replace 'string' with 'none' in the parameters.

Regards,
Takashi Natsume
NTT Software Innovation Center
E-mail: natsume.takashi at lab.ntt.co.jp





More information about the OpenStack-dev mailing list