]> git.ipfire.org Git - thirdparty/bugzilla.git/commitdiff
Bug 880653 - Add POD for Bug.possible_duplicates webservice
authorDave Lawrence <dlawrence@mozilla.com>
Wed, 24 Jul 2013 14:19:05 +0000 (10:19 -0400)
committerDave Lawrence <dlawrence@mozilla.com>
Wed, 24 Jul 2013 14:19:05 +0000 (10:19 -0400)
r=LpSolit,a=sgreen

Bugzilla/WebService/Bug.pm

index 8c59be2a988881ab2929400f8e0ed9a5733a6f91..9ccd84cc257f1dd858c6ab3c9cf2eb6720ccbc8e 100644 (file)
@@ -2018,6 +2018,59 @@ The same as L</get>.
 
 =back
 
+=head2 possible_duplicates
+
+B<UNSTABLE>
+
+=over
+
+=item B<Description>
+
+Allows a user to find possible duplicate bugs based on a set of keywords
+such as a user may use as a bug summary. Optionally the search can be
+narrowed down to specific products.
+
+=item B<Params>
+
+=over
+
+=item C<summary> (string) B<Required> - A string of keywords defining
+the type of bug you are trying to report.
+
+=item C<products> (array) - One or more product names to narrow the
+duplicate search to. If omitted, all bugs are searched.
+
+=back
+
+=item B<Returns>
+
+The same as L</get>.
+
+Note that you will only be returned information about bugs that you
+can see. Bugs that you can't see will be entirely excluded from the
+results. So, if you want to see private bugs, you will have to first 
+log in and I<then> call this method.
+
+=item B<Errors>
+
+=over
+
+=item 50 (Param Required)
+
+You must specify a value for C<summary> containing a string of keywords to 
+search for duplicates.
+
+=back
+
+=item B<History>
+
+=over
+
+=item Added in Bugzilla B<4.0>.
+
+=back
+
+=back
 
 =head2 search