openstack team mailing list archive

[Jay Pipes <jaypipes@xxxxxxxxx>]

The reason I haven't responded yet is because it's difficult for me to:

diff -u some.pdf other.pdf

In all seriousness, the wiki spec page says this about the differences
in the 1.1 OpenStack API:

==start wiki==

OS API 1.1 Features

IPv6

Extensions

Migrate to OpenStack namespace

==end wiki==

There's just not much detail to go on. I had to go through the PDF to
see what the proposed changes to the CS 1.0 API looked like.

After looking at the PDF, I have a couple suggestions for improvement,
but overall things look good :)

1) Give extensions a way to version themselves. Currently, the main
fields in the API response to GET /extensions looks like this:

{
"extensions" : [
{
"name" : "Public Image Extension",
"namespace" : "http://docs.rackspacecloud.com/servers/api/ext/pie/v1.0";,
"alias" : "RS-PIE",
"updated" : "2011-01-22T13:25:27-06:00",
"description" : "Adds the capability to share an image with other users.",
"links" : [
{
"rel" : "describedby",
"type" : "application/pdf",
"href" : "http://docs.rackspacecloud.com/servers/api/ext/cs-pie-20111111.pdf";
},
{
"rel" : "describedby",
"type" : "application/vnd.sun.wadl+xml",
"href" : "http://docs.rackspacecloud.com/servers/api/ext/cs-pie.wadl";
}
]
}, ... ]}

I would suggest adding a "version" field to the extension resource
definition so that extension developers will have a way of identifying
the version of their extension the OpenStack deployment has installed.

2) I would suggest leaving the "links" collection off of the main
result returned by GET /extensions and instead only returned the
"links" collection when a specific extension is queried with a call to
GET /extensions/<ALIAS>. You could even mimick the rest of the CS API
and do a GET /extensions/detail that could return those fields?

3) IPv6 stuff in the PDF looked good as far as I could tell. Mostly, I
was looking at the examples on pages 29 and 30. Was there a specific
section that spoke to IPv6 changes; I could not find one.

Other than those little suggestions, looks like a good start. Would be
great to get the work going on the spec wiki page instead of the PDF,
which nobody on the open source project can modify. I recognize the
PDF comes from the internal Rackspace documents for Cloud Servers, of
course, and that it's not your fault :)  Just encouraging a move to a
format we can edit fluidly.

Cheers, and thanks Gabe!

-jay

On Mon, Feb 14, 2011 at 2:30 PM, John Purrier <john@xxxxxxxxxxxxx> wrote:
> Bumping this to the top of the list. One of the key deliverables for Cactus
> is a complete and usable OpenStack Compute API. This means that using only
> the API and tools that interact with the OpenStack Compute API Nova can be
> installed and configured; once running all of the Nova features and
> functions for VM, Network, and Volume provisioning and management are
> accessible and operable through the API.
>
>
>
> We need your eyes on this, to ensure that the spec is correct. Please take
> the time to review and comment, the more up-front work we do here the better
> the implementation will be.
>
>
>
> Thanks,
>
>
>
> John
>
>
>
> -----Original Message-----
> From: openstack-bounces+john=openstack.org@xxxxxxxxxxxxxxxxxxx
> [mailto:openstack-bounces+john=openstack.org@xxxxxxxxxxxxxxxxxxx] On Behalf
> Of Gabe Westmaas
> Sent: Wednesday, February 09, 2011 3:03 PM
> To: openstack@xxxxxxxxxxxxxxxxxxx
> Subject: [Openstack] OpenStack API 1.1
>
>
>
> A blueprint and proposed spec for OpenStack API 1.1 has been posted and I
> would love to get feedback on the specification.
>
>
>
> Blueprint:
>
> https://blueprints.launchpad.net/nova/+spec/openstack-api-1-1
>
>
>
> Spec wiki:
>
> http://wiki.openstack.org/OpenStackAPI_1-1
>
>
>
> Detailed Spec:
>
> http://wiki.openstack.org/OpenStackAPI_1-1?action=AttachFile&do=view&target=c11-devguide-20110209.pdf
>
>
>
> We'd like to finish up as much of the API implementation for cactus as
> possible, and in particular we want to make sure that we get API extensions
> correct as early as possible.  Other new features in the 1.1 spec include
> the ability to view both IPv4 and v6 addresses, migration to the OpenStack
> namespace and moving from image IDs in responses to URIs (imageRef) for the
> image.  There may be some additional changes as well, please jump in if I
> missed some.
>
>
>
> I will add details to the wiki page as needed based on discussions on the
> mailing list.
>
>
>
> Thanks, and let me know if you have questions.
>
>
>
> Gabe
>
>
>
>
>
> _______________________________________________
>
> Mailing list: https://launchpad.net/~openstack
>
> Post to     : openstack@xxxxxxxxxxxxxxxxxxx
>
> Unsubscribe : https://launchpad.net/~openstack
>
> More help   : https://help.launchpad.net/ListHelp
>
> _______________________________________________
> Mailing list: https://launchpad.net/~openstack
> Post to     : openstack@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~openstack
> More help   : https://help.launchpad.net/ListHelp
>
>