From: Max Kanat-Alexander <mkanat@bugzilla.org>
Date: Mon, 14 Feb 2011 07:42:09 +0000 (-0800)
Subject: Bug 633422: Fix the documentation for User.get's include_disabled parameter
X-Git-Tag: bugzilla-4.0~10
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=95c8b1edd73fd82b134ddb9240cf5a80600657c7;p=thirdparty%2Fbugzilla.git

Bug 633422: Fix the documentation for User.get's include_disabled parameter
and make User.get check that its required parameters are passed.
r=LpSolit, a=mkanat
---

diff --git a/Bugzilla/WebService/User.pm b/Bugzilla/WebService/User.pm
index 4b11611e1c..9f118d4a6b 100644
--- a/Bugzilla/WebService/User.pm
+++ b/Bugzilla/WebService/User.pm
@@ -138,6 +138,11 @@ sub create {
 sub get {
     my ($self, $params) = validate(@_, 'names', 'ids');
 
+    defined($params->{names}) || defined($params->{ids})
+        || defined($params->{match})
+        || ThrowCodeError('params_required', 
+               { function => 'User.get', params => ['ids', 'names', 'match'] });
+
     my @user_objects;
     @user_objects = map { Bugzilla::User->check($_) } @{ $params->{names} }
                     if $params->{names};
@@ -535,8 +540,10 @@ in I<any> of the groups specified.
 =item C<include_disabled> (boolean)
 
 By default, when using the C<match> parameter, disabled users are excluded
-from the returned results. Setting C<include_disabled> to C<true> will include 
-any users that are set to disabled in the returned results.
+from the returned results unless their full username is identical to the
+match string. Setting C<include_disabled> to C<true> will include disabled
+users in the returned results even if their username doesn't fully match
+the input string.
 
 =back