yahoo-eng-team team mailing list archive

[Takashi NATSUME <natsume.takashi@xxxxxxxxxxxxx>]

Public bug reported:

https://developer.openstack.org/api-ref/compute/?expanded=list-security-
groups-by-server-detail#list-security-groups-by-server

In "List Security Groups By Server" API, there are some incorrect
descriptions.

In Response,

* 'security_groups' is optional. But it should be 'required'.

* The description of 'security_groups' is "One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group."
  It is not proper in the response.

* The description of 'id' is: "The security group name or UUID."
　　"name" is not proper here.

* 'rules' is an array. So it had better to change the description in
order to clarify that it is the list of security group rules.

** Affects: nova
     Importance: Undecided
     Assignee: Takashi NATSUME (natsume-takashi)
         Status: In Progress


** Tags: api-ref

** Changed in: nova
       Status: New => In Progress

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1699732

Title:
  api-ref: Incorrect parameter description in server-security-groups.inc

Status in OpenStack Compute (nova):
  In Progress

Bug description:
  https://developer.openstack.org/api-ref/compute/?expanded=list-
  security-groups-by-server-detail#list-security-groups-by-server

  In "List Security Groups By Server" API, there are some incorrect
  descriptions.

  In Response,

  * 'security_groups' is optional. But it should be 'required'.

  * The description of 'security_groups' is "One or more security groups. Specify the name of the security group in the name attribute. If you omit this attribute, the API creates the server in the default security group."
    It is not proper in the response.

  * The description of 'id' is: "The security group name or UUID."
  　　"name" is not proper here.

  * 'rules' is an array. So it had better to change the description in
  order to clarify that it is the list of security group rules.

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1699732/+subscriptions