summaryrefslogtreecommitdiffstats
path: root/Bugzilla/WebService/Util.pm
diff options
context:
space:
mode:
authorFrédéric Buclin <LpSolit@gmail.com>2010-11-04 17:52:29 +0100
committerFrédéric Buclin <LpSolit@gmail.com>2010-11-04 17:52:29 +0100
commitbe891c97c342f6197a72897272fc11c81ba4381e (patch)
treec10e8a5d49b8bc6a39201e4d5bc42c39f9ee7224 /Bugzilla/WebService/Util.pm
parenta56886c1198fdead99e1feced3c02b027bd5d5f0 (diff)
downloadbugzilla-be891c97c342f6197a72897272fc11c81ba4381e.tar.gz
bugzilla-be891c97c342f6197a72897272fc11c81ba4381e.tar.xz
Bug 605573: List all available WebService methods at the top of the POD
r/a=mkanat
Diffstat (limited to 'Bugzilla/WebService/Util.pm')
-rw-r--r--Bugzilla/WebService/Util.pm10
1 files changed, 3 insertions, 7 deletions
diff --git a/Bugzilla/WebService/Util.pm b/Bugzilla/WebService/Util.pm
index e94feb490..adb7fb43a 100644
--- a/Bugzilla/WebService/Util.pm
+++ b/Bugzilla/WebService/Util.pm
@@ -129,25 +129,21 @@ internally in the WebService code.
=head1 METHODS
-=over
-
-=item C<filter>
+=head2 filter
This helps implement the C<include_fields> and C<exclude_fields> arguments
of WebService methods. Given a hash (the second argument to this subroutine),
this will remove any keys that are I<not> in C<include_fields> and then remove
any keys that I<are> in C<exclude_fields>.
-=item C<filter_wants>
+=head2 filter_wants
Returns C<1> if a filter would preserve the specified field when passing
a hash to L</filter>, C<0> otherwise.
-=item C<validate>
+=head2 validate
This helps in the validation of parameters passed into the WebSerice
methods. Currently it converts listed parameters into an array reference
if the client only passed a single scalar value. It modifies the parameters
hash in place so other parameters should be unaltered.
-
-=back