diff options
author | Dave Lawrence <dlawrence@mozilla.com> | 2013-07-24 16:12:03 +0200 |
---|---|---|
committer | Dave Lawrence <dlawrence@mozilla.com> | 2013-07-24 16:12:03 +0200 |
commit | 682304dcfc97a07575195b8bd40c6e83d9350fe3 (patch) | |
tree | 923555e782cda048eae7c3cb52e628f4708cb1b7 /Bugzilla/WebService | |
parent | ea996b7667a9a01159f38bb4c6515782eb59609e (diff) | |
download | bugzilla-682304dcfc97a07575195b8bd40c6e83d9350fe3.tar.gz bugzilla-682304dcfc97a07575195b8bd40c6e83d9350fe3.tar.xz |
Bug 880653 - Add POD for Bug.possible_duplicates webservice
r=LpSolit,a=sgreen
Diffstat (limited to 'Bugzilla/WebService')
-rw-r--r-- | Bugzilla/WebService/Bug.pm | 55 |
1 files changed, 53 insertions, 2 deletions
diff --git a/Bugzilla/WebService/Bug.pm b/Bugzilla/WebService/Bug.pm index 391ea69bc..9c4906883 100644 --- a/Bugzilla/WebService/Bug.pm +++ b/Bugzilla/WebService/Bug.pm @@ -2301,6 +2301,59 @@ names used by L<Bug.update|/"update"> for consistency. =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 @@ -3592,8 +3645,6 @@ This method can throw the same errors as L</get>. =item get_bugs -=item possible_duplicates - =item get_history =back |