← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1638606] [NEW] api-ref: create keypair response is confusing wrt user_id and microversion 2.10

 

Public bug reported:

This is the api-ref doc on the create keypair response;

http://developer.openstack.org/api-ref/compute/?expanded=list-volume-
attachments-for-an-instance-detail,create-or-import-keypair-detail#id210

The user_id description in the response is confusing since it says 'New
in version 2.10'. In v2.1 the user_id is required in the response per
Tempest:

https://github.com/openstack/tempest/blob/13.0.0/tempest/lib/api_schema/response/compute/v2_1/keypairs.py#L66

And the code:

https://github.com/openstack/nova/blob/14.0.1/nova/api/openstack/compute/keypairs.py#L138

So we should update the docs a bit to not mention version 2.10 in the
user_id description for the keypair response.

** Affects: nova
     Importance: Low
     Assignee: Matt Riedemann (mriedem)
         Status: Triaged


** Tags: api-ref

-- 
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/1638606

Title:
  api-ref: create keypair response is confusing wrt user_id and
  microversion 2.10

Status in OpenStack Compute (nova):
  Triaged

Bug description:
  This is the api-ref doc on the create keypair response;

  http://developer.openstack.org/api-ref/compute/?expanded=list-volume-
  attachments-for-an-instance-detail,create-or-import-keypair-
  detail#id210

  The user_id description in the response is confusing since it says
  'New in version 2.10'. In v2.1 the user_id is required in the response
  per Tempest:

  https://github.com/openstack/tempest/blob/13.0.0/tempest/lib/api_schema/response/compute/v2_1/keypairs.py#L66

  And the code:

  https://github.com/openstack/nova/blob/14.0.1/nova/api/openstack/compute/keypairs.py#L138

  So we should update the docs a bit to not mention version 2.10 in the
  user_id description for the keypair response.

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


Follow ups