openstack team mailing list archive

[Anne Gentle <anne@xxxxxxxxxxxxx>]

Hi Phil -
An attempt at responses below, hopefully others can chime in where my
knowledge is limited. To answer an overarching (or is it underlying?)
question, the end goal is that the API descriptive specs are at
docs.openstack.org/api (even though some are named developer guides),
and the implementation in TryStack is documented at api.openstack.org.
Extensions are documented on api.openstack.org.

On Wed, May 30, 2012 at 8:33 AM, Day, Phil <philip.day@xxxxxx> wrote:
> Hi Folks,
>
> I was looking for the full definition of the API requests, and I’m a tad
> confused by what I find here:
>
> http://api.openstack.org/
>
> Specifically for Server Create there is both and “Server – Create” and
> “Server – Extended Create”, although as far as I can see the “extended
> create” isn’t actually an extension as such (the additional parameters are
> supported in the core servers module).
>
>

Extended Create is an extension as I understand it. When I query
TryStack I see {"updated": "2011-07-19T00:00:00+00:00", "name":
"Createserverext", "links": [], "namespace":
"https://docs.openstack.org/ext/createserverext/api/v1.1";, "alias":
"os-create-server-ext", "description": "Extended support to the Create
Server v1.1 API"}, {"updated": "2011-08-08T00:00:00+00:00",

So to me that means the action servers is extended but because it uses
the same action, it seems a part of core (and min_count and max_count
are required aren't they?). Brian Waldon can probably explain better
than I can.

>
> Also there seem to be a number of parameter values that aren’t specified in
> either interface entry, such as:
>
> min_count
>
> max_count
>
> networks
>
> key_name
>

I logged this as a doc bug:
https://bugs.launchpad.net/openstack-manuals/+bug/1006654

>
> So is the API document intended to be:
>
>
>
> -          A formal specification of the Interface
>
> -          A set of examples  (but if you want the details you need to read
> the code)
>

One of my goals going forward is crisper lines for docs about using
the APIs and docs describing the APIs. Users of the API should not
need to read Python code to use an OpenStack API. Thanks for your
observations.

Anne