Open Stack

On Wed, Jul 6, 2016 at 8:51 AM, Atsushi SAKAI <sakaia at jp.fujitsu.com> wrote:
> Tom,
>
>> So, what would help better explain versioning in the API context? A
>> table lookup for API version matched to release?
>>
>> This input will help with both the landing page project and the
>> navigation work in progress.
>
> The versioning description seems different with each component
> In any case, it is difficult.
>
> nothing
>   http://developer.openstack.org/api-ref/compute/
>   http://developer.openstack.org/api-ref/orchestration/
>   http://developer.openstack.org/api-ref/baremetal/   => only one version
>   http://developer.openstack.org/api-ref-objectstorage-v1.html
>
> some description
>   http://developer.openstack.org/api-ref/image/
>   http://developer.openstack.org/api-ref/identity/

Yes, it is difficult across services to convey what this user wants.

Also look at https://api.os.gra.ham.ie/mv-select/ where Graham Hayes
is working on microversions in a drop-down selector. I think this type
of interface is likely what this user is looking for, but would like
to confirm.

Any input on the above navigation addition?

Thanks,
Anne


>
> Thanks
> Atsushi SAKAI
>
> On Wed, 6 Jul 2016 08:26:48 -0500
> Anne Gentle <annegentle at justwriteclick.com> wrote:
>
>> Thanks for the input and for ensuring it comes to the list, Tom!
>>
>> On Wed, Jul 6, 2016 at 2:59 AM, Tom Fifield <tom at openstack.org> wrote:
>> > Hi docs!
>> >
>> > Passing along some feedback from the ops session here in Tokyo. #3 comment
>> > that came up was:
>> >
>> > " api reference (http://developer.openstack.org/api-ref.html) need per
>> > OpenStack version (eg "Mitaka") API ref. currently only "current" where you
>> > don't know when the current is."
>>
>> In the API context, the release name isn't the version. The version is
>> for the API. To quote from the top of the landing page:
>>
>> The API status reflects the state of the endpoint on the service.
>> CURRENT is a stable version that is up-to-date, recent, and might
>> receive future versions. This endpoint should be prioritized over all
>> others. SUPPORTED is a stable version that is available on the server.
>> However, it is not likely the most recent available and might not be
>> updated or might be deprecated at some time in the future. DEPRECATED
>> is a stable version that is still available but is being deprecated
>> and might be removed in the future. EXPERIMENTAL is not a stable
>> version. This version is under development or contains features that
>> are otherwise subject to change. For more information about API status
>> values and version information, see Version Discovery.
>>
>> So, what would help better explain versioning in the API context? A
>> table lookup for API version matched to release?
>>
>> This input will help with both the landing page project and the
>> navigation work in progress.
>>
>> Thanks,
>> Anne
>>
>>
>>
>> >
>> > https://etherpad.openstack.org/p/JP-Ops-workshop-2
>> >
>> >
>> > Regards,
>> >
>> >
>> > Tom
>> >
>> > _______________________________________________
>> > OpenStack-docs mailing list
>> > OpenStack-docs at lists.openstack.org
>> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>>
>>
>> --
>> Anne Gentle
>> www.justwriteclick.com
>>
>> _______________________________________________
>> OpenStack-docs mailing list
>> OpenStack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>
> --
> Atsushi SAKAI <sakaia at jp.fujitsu.com>



-- 
Anne Gentle
www.justwriteclick.com