Bugzilla:BzAPI: Difference between revisions

Bugzilla:BzAPI (view source)

Revision as of 10:19, 17 October 2011

105 bytes added , 17 October 2011

no edit summary

Gerv

Account confirmers, Anti-spam team, Confirmed users, Bureaucrats and Sysops emeriti

4,925

edits

@@ Line 13: / Line 13: @@
 Older pages in this wiki document released versions of BzAPI.
-===Version 0.8 (14th November 2010)===
+===Version 0.9 (2nd February 2011)===
-* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API&oldid=267570 Overview]
+* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API&oldid=281694 Overview]
-* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Methods&oldid=267566 API Methods]
+* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Methods&oldid=281673 API Methods]
-** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Search&oldid=189990 Parameters for the Search method]
+** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Search&oldid=281682 Parameters for the Search method]
-* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects&oldid=267569 Objects sent and received]
+* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects&oldid=281684 Objects sent and received]
 ** [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:Objects:Configuration&oldid=265440 The Configuration object]
-* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:HowTo&oldid=267568 Tips, tricks and code samples]
+* [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API:HowTo&oldid=281685 Tips, tricks and code samples]
-===Version 0.9 (2nd February 2011)===
+===Version 1.0 (17th October 2011)===
 * [https://wiki.mozilla.org/index.php?title=Bugzilla:REST_API&oldid=281694 Overview]
@@ Line 37: / Line 37: @@
 Main Mozilla server (https://bugzilla.mozilla.org/):
-  [https://api-dev.bugzilla.mozilla.org/0.9/ https://api-dev.bugzilla.mozilla.org/0.9/]
+  [https://api-dev.bugzilla.mozilla.org/1.0/ https://api-dev.bugzilla.mozilla.org/1.0/]
   [https://api-dev.bugzilla.mozilla.org/latest/ https://api-dev.bugzilla.mozilla.org/latest/]
 Testing server (http://landfill.bugzilla.org/bzapi_sandbox/):
-  [https://api-dev.bugzilla.mozilla.org/test/0.9/ https://api-dev.bugzilla.mozilla.org/test/0.9/]
+  [https://api-dev.bugzilla.mozilla.org/test/1.0/ https://api-dev.bugzilla.mozilla.org/test/1.0/]
   [https://api-dev.bugzilla.mozilla.org/test/latest/ https://api-dev.bugzilla.mozilla.org/test/latest/]
@@ Line 105: / Line 105: @@
 * the <b>latest</b> stable 3.4.x, 3.6.x or 4.0.x point release of Bugzilla (many features will not work on 3.2); and
 * to be using UTF-8 (this is the default on new installations); and
-* to have the necessary optional modules for XML-RPC (e.g. Test::Taint).
+* to have the necessary optional modules for XML-RPC (e.g. Test::Taint); and
+* to apply the patches noted below.
 Then, install a copy of the API software - it does not have to be on the same machine. See the INSTALL file in the repository for some installation hints; feel free to send me tips from your experience.
@@ Line 123: / Line 124: @@
    BZ::Client Catalyst::Plugin::Log::Handler
-===Extension (or Patches)===
+===Required Extension and/or Patch(es)===
+There are two changes you need to make.
 Even the latest stable release of Bugzilla requires a little modification to work properly with the BzAPI. Unfortunately, it is not possible to support all the necessary functionality without some changes to Bugzilla itself, which the Bugzilla team have declined to take.
-So, for Bugzilla 3.6 and above, there is a Bugzilla Extension which adds the necessary functionality. Find it in <tt>$BZAPI_HOME/extension</tt>; copy the <tt>BzAPI</tt> directory from there into <tt>$BUGZILLA_HOME/extensions</tt>.
+So, firstly, for Bugzilla 3.6 and above, there is a Bugzilla Extension which adds the necessary functionality. Find it in <tt>$BZAPI_HOME/extension</tt>; copy the <tt>BzAPI</tt> directory from there into <tt>$BUGZILLA_HOME/extensions</tt>.
-If you are on 3.4 or below, you need a patch and a template. These are shipped  in the BzAPI distribution, in the <tt>patches</tt> directory, from version 0.8 onwards. See the INSTALL file for details.
+If you are on 3.4 or below, you need a patch and a template. These are shipped in the BzAPI distribution, in the <tt>patches</tt> directory, from version 0.8 onwards. See the INSTALL file for details.
-Also, if you are using non-ASCII characters at all, you need to patch the BZ::Client module, which has an encoding bug. The patch for that is also in the <tt>patches</tt> directory.
+Secondly, if you are using non-ASCII characters at all, you need to patch the BZ::Client module, which has an encoding bug. The patch for that is also in the <tt>patches</tt> directory.