yahoo-eng-team team mailing list archive
-
yahoo-eng-team team
-
Mailing list archive
-
Message #65811
[Bug 1699732] Re: api-ref: Incorrect parameter description in server-security-groups.inc
Reviewed: https://review.openstack.org/476434
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=3f96ec6490c72d3646813f1a9d3ee38773ec1823
Submitter: Jenkins
Branch: master
commit 3f96ec6490c72d3646813f1a9d3ee38773ec1823
Author: Takashi NATSUME <natsume.takashi@xxxxxxxxxxxxx>
Date: Thu Jun 22 17:40:47 2017 +0900
api-ref: Fix parameters in server-security-groups
Change-Id: Ie8dc3252603ce77910e1addb67cdc8844369dfca
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1699732
** Changed in: nova
Status: In Progress => Fix Released
--
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):
Fix Released
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
References