BMO/REST: Difference between revisions

From MozillaWiki
< BMO
Jump to navigation Jump to search
(Created page with "= Bringing Native REST API to BMO = Currently if you want to access BMO data via REST, you have to use the BzAPI which is a [https://wiki.mozilla.org/Bugzilla:REST_API| separ...")
 
(Making the native rest api docs the default)
 
(13 intermediate revisions by 7 users not shown)
Line 1: Line 1:
= Bringing Native REST API to BMO =
#REDIRECT [[Bugzilla:REST API]]
 
Currently if you want to access BMO data via REST, you have to use the BzAPI which is a [https://wiki.mozilla.org/Bugzilla:REST_API| separate proxy system] outside of BMO. The system hosting the proxy is not maintained by Mozilla IT and will be decommissioned at some point.
 
Bugzilla should allow access to data via REST API similar to XMLRPC and JSONRPC. The current code base can be extended to allow REST API calls using the same backend code to retrieve the data as well as submit data.
 
Later, we want to extend the native REST API to allow clients to access BMO the same way they currently interact with the BzAPI system so that they can point their clients to BMO once the proxy system is decommissioned.
 
== Development Phases ==
 
=== Phase One ===
 
* Extend the current upstream WebServices (XMLRPC, JSONRPC) to allow accessing the same data over REST. Currently being discussed in [https://bugzilla.mozilla.org/show_bug.cgi?id=866927 bug 866927].
 
=== Phase Two ===
 
* Create an extension on BMO that manipulates the data coming in and going out so that a client who currently accesses BMO data via the proxy, will just need to change the hostname and continue to use their client code.
* The path will be slightly different depending on which API you want to use, the native one, or the one compatible with the BzAPI proxy.
* There is discussion in [https://bugzilla.mozilla.org/show_bug.cgi?id=866927 bug 866927] about making small changes to the current upstream API that bring it closer to the format used by the BzAPI proxy. We will create individual bugs as needed for any changes that are to be made. Also there was mention about somehow versioning the different API changes so that users can still continue to use an older format rather than breaking their client code.
* A page has been created that outlines out the key differences between the upstream WebService API and the BzAPI to see how much needs to be done to bring the two closer.
 
=== Phase Three ===
 
* Announce far and wide that the BzAPI proxy will be decommissioned by some group determined date and help users port their client over to the BMO system as needed.
* Decommission api-dev.bugzilla.mozilla.org on the date agreed upon.

Latest revision as of 17:09, 7 July 2014

Redirect to: