Hi,
The 1.0 API will remain and should work just as it has in Review Board 1.0.
Any regressions there is a bug that we'll have to fix.
No 1.0 APIs will work with the new API in 1.5, partially because it's based
on paths (and they'll be different between 1.0 and 1.5), and partially
because the new API is more of a proper RESTful API (that is, it uses
appropriate HTTP status codes instead of just 200 OK, and uses PUT and
DELETE along with GET and POST).
I am planning guides on "How do I do [something]," such as "How do I post a
review" or "How do I query for review requests," etc. This won't happen
until after I've updated all the RB admin and user manual content for the
1.5 release, and then actually release it.
A migration guide is a good idea, and I think I'll put that on my list. No
ETA though. There'd be a lot to cover.
Christian
--
Christian Hammond - chip...@chipx86.com
Review Board - http://www.reviewboard.org
VMware, Inc. - http://www.vmware.com
On Tue, Sep 7, 2010 at 10:31 PM, Gilles Moris wrote:
> Hi Christian,
>
> Is there a compatibility guide, ie which 1.0 API may not work with the new
> one
> or work differently ?
>
> Thanks.
> Gilles.
>
> On Saturday 04 September 2010 09:12:35 pm Christian Hammond wrote:
> > Hi everyone,
> >
> > I realized today that I never really announced the new web API
> > documentation for Review Board 1.5.
> >
> > Last week, I put up the first version of the new docs. They're available
> at
> > http://www.reviewboard.org/docs/manual/dev/webapi/. These cover
> > authentication, the resources, HTTP methods per-resource, possible error
> > codes, and more. There is still work to be done, including adding some
> "How
> > To" docs on such things as creating new review requests or commenting or
> > iterating lists of results. These will be done incrementally.
> >
> > The old docs are still linked to and won't be going away. However, Review
> > Board 1.0's API is feature-frozen at this point, and all new work will
> > focus on the API in 1.5.
> >
> > I'd welcome any feedback on the docs as people start to use them.
> >
> > Christian
> >
> > --
> > Christian Hammond - chip...@chipx86.com
> > Review Board - http://www.reviewboard.org
> > VMware, Inc. - http://www.vmware.com
>
>
>
--
Want to help the Review Board project? Donate today at
http://www.reviewboard.org/donate/
Happy user? Let us know at http://www.reviewboard.org/users/
-~--~~~~--~~--~--~---
To unsubscribe from this group, send email to
reviewboard+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/reviewboard?hl=en
