Keypair extension to create server REST API not documented

Bug #1300870 reported by Samuel Matzek
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
Medium
Diane Fleming

Bug Description

URL:
http://api.openstack.org/api-ref-compute-v2-ext.html

The os-keypairs compute extension extends the:
POST v2/​{tenant_id}​/servers
API to add an optional key_name parameter. This is not documented in the API reference page.
It should be documented in the Keypairs (os-keypairs) section so REST callers know how to pass the key pair name on a create server request. The "Configuration Drive" extension documents its extension to the create server API in its extension section and keypairs should do likewise.

Tags: compute-api
Akihiro Motoki (amotoki)
tags: added: compute-api
Changed in openstack-api-site:
importance: Undecided → Medium
status: New → Confirmed
Revision history for this message
Diane Fleming (diane-fleming) wrote :
Changed in openstack-api-site:
status: Confirmed → Fix Released
assignee: nobody → Diane Fleming (diane-fleming)
milestone: none → liberty
Revision history for this message
Samuel Matzek (smatzek) wrote :

This is not yet fixed. What is needed is the http://developer.openstack.org/api-ref-compute-v2-ext.html#os-keypairs section needs to have documentation added for the POST /v2/​{tenant_id}​/servers API call.

The os-keypairs extension adds an optional parameter named 'key-name' to that servers POST body to specify the key pair name on the server create call. This is not documented anywhere in the API ref.

In comparison, the configuration drive extension, http://developer.openstack.org/api-ref-compute-v2-ext.html#os-createserverext, does document the optional 'config_drive' parameter it adds to POST /v2/​{tenant_id}​/servers

Changed in openstack-api-site:
status: Fix Released → Confirmed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to api-site (master)

Fix proposed to branch: master
Review: https://review.openstack.org/189073

Changed in openstack-api-site:
status: Confirmed → In Progress
Revision history for this message
Diane Fleming (diane-fleming) wrote :
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/189073
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=7de98ee3b1ab2b62d6cc405784a9d58b8d414600
Submitter: Jenkins
Branch: master

commit 7de98ee3b1ab2b62d6cc405784a9d58b8d414600
Author: Diane Fleming <email address hidden>
Date: Sat Jun 6 19:10:45 2015 -0500

    Add key_name parameter to create server request

    Change-Id: I96ffca8af2fbd03c3c34054f1a1fd03435d1f1b8
    Closes-Bug: #1300870

Changed in openstack-api-site:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.