[openstack-dev] [all] versioning the api-ref?

Anne Gentle annegentle at justwriteclick.com
Fri Aug 26 14:54:40 UTC 2016


On Fri, Aug 26, 2016 at 7:46 AM, Bashmakov, Alexander <
alexander.bashmakov at intel.com> wrote:

> Any more feedback on this?
>

Hi, I've added a comment on the review. For now, inline text descriptions
are best for the context of what you're adding in that particular place.

Anne


>
> > On Aug 18, 2016, at 10:30 AM, Bashmakov, Alexander <
> alexander.bashmakov at intel.com> wrote:
> >
> > Concrete example of an api-ref difference between Mitaka and Newton:
> > https://review.openstack.org/#/c/356693/1/api-ref/source/v2/
> images-parameters.yaml
> >
> > -----Original Message-----
> > From: Sean Dague [mailto:sean at dague.net]
> > Sent: Thursday, August 18, 2016 10:20 AM
> > To: Nikhil Komawar <nik.komawar at gmail.com>; OpenStack Development
> Mailing List (not for usage questions) <openstack-dev at lists.openstack.org>
> > Subject: Re: [openstack-dev] [all] versioning the api-ref?
> >
> >> On 08/18/2016 11:57 AM, Nikhil Komawar wrote:
> >> I guess the intent was to indicate the need for indicating the micro
> >> or in case of Glance minor version bump when required.
> >>
> >> The API isn't drastically different, there are new and old elements as
> >> shown in the Nova api ref linked.
> >
> > Right, so the point is that it should all be describable in a single
> document. It's like the fact that when you go to python API docs you get
> things like - https://docs.python.org/2/library/wsgiref.html
> >
> > "New in version 2.5."
> >
> > Perhaps if there is a concrete example of the expected differences
> between what would be in the mitaka tree vs. newton tree was can figure out
> an appropriate way to express that in api-ref.
> >
> >    -Sean
> >
> > --
> > Sean Dague
> > http://dague.net
> >
> > ____________________________________________________________
> ______________
> > OpenStack Development Mailing List (not for usage questions)
> > Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:
> unsubscribe
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> >
> > ____________________________________________________________
> ______________
> > OpenStack Development Mailing List (not for usage questions)
> > Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:
> unsubscribe
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>



-- 
Anne Gentle
www.justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20160826/2eab65db/attachment.html>


More information about the OpenStack-dev mailing list