[OpenStack-docs] API Reference gen questions

Anne Gentle annegentle at justwriteclick.com
Mon Jun 29 13:50:04 UTC 2015


I'll attempt to answer as if it's a quiz and then Russell can tell us
what's right and wrong when he gets back online Aussie time. :)

On Mon, Jun 29, 2015 at 8:03 AM, Karen Bradshaw <kbhawkey at gmail.com> wrote:

> Hi, Russell.  I just started to look at this code but thought of a few
> questions,
> 1) How did you validate the generated swagger-json files?
>

Typically you'd use the JSON schema from Swagger itself, see
https://github.com/swagger-api/swagger-spec/blob/master/schemas/v2.0/schema.json

However he noted the need for a new schema, which you mention below.


> 2) Did you create a new schema, Swagger 2.0-OpenStack?  What
> does it look like?
>

It doesn't exist yet, so we'll need to make it.


> 3) Can you elaborate a bit more about the tagging system?
>

I think Tags in Swagger are per-route. A route is a method (like GET or
POST) plus a path (like {tenant_id}/servers/detail).

However we have groups of Tags for say, "Servers" that has a lot of
conceptual information in it:
http://developer.openstack.org/api-ref-compute-v2.html#compute_servers So
we need a way to group Tags so that we can insert the conceptual
information where it makes sense.

And yes, I believe that's the "narrative doc" we talked about at the
Summit.

Hope that helps - and hopefully Russell fills in the blanks I've left.

Anne




> Thanks!
> -Karen
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>


-- 
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150629/5837fcbc/attachment.html>


More information about the OpenStack-docs mailing list