[openstack-dev] [nova] The definition of 'Optional' parameter in API reference

Takashi Natsume natsume.takashi at lab.ntt.co.jp
Mon Jul 3 04:38:59 UTC 2017


Hi, all.

In Nova API reference, there is inconsistency in
whether to define parameters added in new microversion as 'optional' or not.

In the case that the parameter is always included in the response after  
a certain microversion,
some parameters(e.g. 'type' [1]) are defined as 'required', but some  
parameters (e.g. 'project_id', 'user_id'[2])
are defined as 'optional'.

[1] List Keypairs in Keypairs (keypairs)
  
https://developer.openstack.org/api-ref/compute/?expanded=list-keypairs-detail#list-keypairs

[2] List Server Groups in Server groups (os-server-groups)
  
https://developer.openstack.org/api-ref/compute/?expanded=list-server-groups-detail#list-server-groups


In the case that the parameter is always included in the response after  
a certain microversion,
should it be defined as 'required' instead of 'optional'?

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




More information about the OpenStack-dev mailing list