summaryrefslogtreecommitdiffstats
path: root/Bugzilla/WebService
diff options
context:
space:
mode:
authorMax Kanat-Alexander <mkanat@bugzilla.org>2011-02-14 08:41:25 +0100
committerMax Kanat-Alexander <mkanat@bugzilla.org>2011-02-14 08:41:25 +0100
commit739d3a205aa7e3da1525eb8cce2ee7ef46317702 (patch)
tree7177200aeffcfd89b33ff5ea922fd94596a7873c /Bugzilla/WebService
parent823c0e4a586aa3207d9c380d0cba8e46a65989b3 (diff)
downloadbugzilla-739d3a205aa7e3da1525eb8cce2ee7ef46317702.tar.gz
bugzilla-739d3a205aa7e3da1525eb8cce2ee7ef46317702.tar.xz
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
Diffstat (limited to 'Bugzilla/WebService')
-rw-r--r--Bugzilla/WebService/User.pm11
1 files changed, 9 insertions, 2 deletions
diff --git a/Bugzilla/WebService/User.pm b/Bugzilla/WebService/User.pm
index 4b11611e1..9f118d4a6 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