Open Stack

Hi Matt and all -

I do think these are good reasons, but in the case of the Compute API,
the namespace is 1.1 and the version is 2. Will we cause more
consternation and confusion than alleviate with a resolving namespace?

I'm talking with the team that primarily works on the Clouddoctools
that outputs api.openstack.org,
https://github.com/rackspace/clouddocs-maven-plugin, all are welcome
to poke at it as well to see what they think the scope of the work is.

I'd like a user-friendly API, and I'm happy to assist. In this case,
we've got a larger issue to visit. Thoughts?

Anne

On Thu, Oct 11, 2012 at 10:44 PM, Matt Joyce
<matt.joyce at cloudscaling.com> wrote:
> namespace urls do not NEED to resolve.
>
> but, they can.  and that would be nice for 2 reasons I can think of.
>
> 1.  when you google for docs on an api method without a real documentation
> url those links show up and 404.  That is annoying.  Also if they do
> resolve, the namespace url suddenly picks up a second use.  Which is pretty
> nice.
>
> 2.  the namespace urls are used to map in namespace all the api methods.
> which means it's something of an authoritative source of api calls.  This
> means you can gate test for documentation, or simply get quick stats on how
> many methods are undocumented.
>
> that's my thinking anyways.
>
> -Matt
>
>
> On Thu, Oct 11, 2012 at 8:33 PM, Anne Gentle <anne at openstack.org> wrote:
>>
>> Hi all -
>>
>> I'm doing some legwork on how feasible and how much work this is - don't
>> have an informed opinion yet. I was always told that the namespace is just a
>> string and does not need to resolve for each method.
>>
>> Anne
>>
>> On Oct 9, 2012, at 3:14 PM, Matt Joyce <matt.joyce at cloudscaling.com>
>> wrote:
>>
>> https://bugs.launchpad.net/openstack-manuals/+bug/1064645
>>
>> Filed this bug for the documentation.
>>
>> Is anyone opposed to the idea of making existence of corresponding method
>> documentation a condition of namespace test cases in CI?
>>
>> -Matt
>>
>> _______________________________________________
>> OpenStack-dev mailing list
>> OpenStack-dev at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>
>>
>> _______________________________________________
>> OpenStack-dev mailing list
>> OpenStack-dev at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>
>
>
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>