Bugzilla:REST API: Difference between revisions

Bugzilla:REST API (view source)

Revision as of 01:24, 8 July 2014

644 bytes removed , 8 July 2014

→‎Background

Mcote

Confirmed users

1,927

edits

@@ Line 16: / Line 16: @@
 Until recently, Bugzilla supported only older technologies, namely XMLRPC and JSONRPC.  The BMO team created a new REST API in the summer of 2013 to provide a modern Web interface to Bugzilla.
-Prior to the native REST API, a separate proxy service called [[Bugzilla:REST_API|BzAPI]] was created that provided a REST API using data obtained through the older RPC interfaces as well as various other Bugzilla data sources, including CSV representations.  This was a great interim solution, but now that we have a native API, and since the system hosting the proxy is not maintained by Mozilla IT, the bzAPI service will be decommissioned at some point.  See [[Bugzilla:API_Comparison]] for the differences and between bzAPI and the native API.
+Prior to the native REST API, a separate proxy service called [[Bugzilla:REST_API|BzAPI]] was created that provided a REST API using data obtained through the older RPC interfaces as well as various other Bugzilla data sources, including CSV representations.  See the docs on the [[Bugzilla:BzAPI:CompatLayer|BzAPI-compatibility layer]] for more info.
-To ease the transition, we are creating a native bzAPI compatibility layer ({{bug|880669}}) that will act exactly the same as bzAPI but will translate the queries to the native API layer.  Thus clients who currently accesses BMO data via the proxy will just need to change the REST url to move to the built-in API.  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 has been discussion in {{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. We also plan on versioning the different API changes so that users can still continue to use an older format rather than breaking their client code.
-There is discussion in {{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. We also plan on versioning the different API changes so that users can still continue to use an older format rather than breaking their client code.
 == Documentation ==