Warn against multiple items in some {XML,JSON}RPC calls.

Fix #84.

1 files changed, 30 insertions, 0 deletions

diff --git a/data/tweaks/bug-page-mod.js b/data/tweaks/bug-page-mod.js
index 0e3d431..d0f8095 100644
--- a/data/tweaks/bug-page-mod.js
+++ b/data/tweaks/bug-page-mod.js
@@ -63,6 +63,36 @@ function TweakOnMessageHandler(msg, nextHandler) {
 function collectHistory(rpcURL) {
   // https://bugzilla.redhat.com/docs/en/html/api/Bugzilla\
   // /WebService/Bug.html#Bug_Information
+  /*
+  This is a heads up on a change that we will be making soon with Bugzilla. The
+  component, version and target release fields will become multi-select fields.
+  This means a bug will have one or more values for these fields (currently they
+  can only have one value for each field).
+  If you use the RPC scripts, this change will affect the results you send and
+  receive to it. For example, in the Bug.get function, the XML for the
+  target_release field currently is:
+             {{{
+             <member>
+                 <name>target_release</name>
+                 <value><string>release_1</string></value>
+             </member>
+             }}}
+             the new XML will read:
+             {{{
+             <member><name>target_release</name>
+                 <value><array><data>
+                     <value><string>release_1</string></value>
+                     <value><string>release_1</string></value>
+                 </data></array></value>
+             </member>
+             }}}
+  We plan to release this change on our test server -
+  https://partner-bugzilla.redhat.com/ - this Wednesday April 20th EDT. An
+  announcement will be sent to bugzilla-announce-list redhat com when we make
+  the change.
+  The change will be made to the production servers in early May, with
+  notification to the announce list prior to the change.
+   */
   var bugId = getBugNo();
   self.postMessage(new Message("MakeJSONRPCall", {
     url : rpcURL.replace("xmlrpc.cgi","jsonrpc.cgi"),