From 32931bb0370328c142e9d63f410d94f9db3c764d Mon Sep 17 00:00:00 2001 From: David Lawrence Date: Fri, 11 Apr 2014 14:58:03 +0000 Subject: Bug 540818 - Improve include_fields and exclude_fields to accept _default, _all and _custom keywords r=glob,a=justdave --- Bugzilla/WebService.pm | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) (limited to 'Bugzilla/WebService.pm') diff --git a/Bugzilla/WebService.pm b/Bugzilla/WebService.pm index 92ffed659..9638d1132 100644 --- a/Bugzilla/WebService.pm +++ b/Bugzilla/WebService.pm @@ -319,6 +319,34 @@ for GET type requests. =back +There are several shortcut identifiers to ask for only certain groups of +fields to be returned or excluded. + +=over + +=item C<_all> + +All possible fields are returned if C<_all> is specified in C. + +=item C<_default> + +These fields are returned if C is empty or C<_default> +is specified. All fields described in the documentation are returned +by default unless specified otherwise. + +=item C<_extra> + +These fields are not returned by default and need to be manually specified +in C either by field name, or using C<_extra>. + +=item C<_custom> + +Only custom fields are returned if C<_custom> is specified in C. +This is normally specific to bug objects and not relevant for other returned +objects. + +=back + =head1 SEE ALSO =head2 Server Types -- cgit v1.2.3-24-g4f1b