This is the standard API for external programs that want to interact
with Bugzilla. It provides various methods in various modules.
+Currently the only method of accessing the API is via XML-RPC. The XML-RPC
+standard is described here: L<http://www.xmlrpc.com/spec>
+
+The endpoint for Bugzilla WebServices is the C<xmlrpc.cgi> script in
+your Bugzilla installation. For example, if your Bugzilla is at
+C<bugzilla.yourdomain.com>, then your XML-RPC client would access the
+API via: C<http://bugzilla.yourdomain.com/xmlrpc.cgi>
+
+=head1 CALLING METHODS
+
+Methods are called in the normal XML-RPC fashion. Bugzilla does not currently
+implement any extensions to the standard method of XML-RPC method calling.
+
+Methods are grouped into "packages", like C<Bug> for
+L<Bugzilla::WebService::Bug>. So, for example,
+L<Bugzilla::WebService::Bug/get>, is called as C<Bug.get> in XML-RPC.
+
+=head1 PARAMETERS
+
+In addition to the standard parameter types like C<int>, C<string>, etc.,
+XML-RPC has two data structures, a C<< <struct> >> and an C<< <array> >>.
+
+=head2 Structs
+
+In Perl, we call a C<< <struct> >> a "hash" or a "hashref". You may see
+us refer to it that way in the API documentation.
+
+In example code, you will see the characters C<{> and C<}> used to represent
+the beginning and end of structs.
+
+For example, here's a struct in XML-RPC:
+
+ <struct>
+ <member>
+ <name>fruit</name>
+ <value><string>oranges</string></value>
+ </member>
+ <member>
+ <name>vegetable</name>
+ <value><string>lettuce</string></value>
+ </member>
+ </struct>
+
+In our example code in these API docs, that would look like:
+
+ { fruit => 'oranges', vegetable => 'lettuce' }
+
+=head2 Arrays
+
+In example code, you will see the characters C<[> and C<]> used to
+represent the beginning and end of arrays.
+
+For example, here's an array in XML-RPC:
+
+ <array>
+ <data>
+ <value><i4>1</i4></value>
+ <value><i4>2</i4></value>
+ <value><i4>3</i4></value>
+ </data>
+ </array>
+
+In our example code in these API docs, that would look like:
+
+ [1, 2, 3]
+
+=head2 How Bugzilla WebService Methods Take Parameters
+
+B<All> Bugzilla WebServices functions take their parameters in
+a C<< <struct> >>. Another way of saying this would be: All functions
+take a single argument, a C<< <struct> >> that contains all parameters.
+The names of the parameters listed in the API docs for each function are
+the C<name> element for the struct C<member>s.
+
+=head1 LOGGING IN
+
+You can use L<Bugzilla::WebService::User/login> to log in as a Bugzilla
+user. This issues standard HTTP cookies that you must then use in future
+calls, so your XML-RPC client must be capable of receiving and transmitting
+cookies.
+
=head1 STABLE, EXPERIMENTAL, and UNSTABLE
Methods are marked B<STABLE> if you can expect their parameters and
=head1 METHODS
-See L<Bugzilla::WebService> for a description of B<STABLE>, B<UNSTABLE>,
-and B<EXPERIMENTAL>.
+See L<Bugzilla::WebService> for a description of how parameters are passed,
+and what B<STABLE>, B<UNSTABLE>, and B<EXPERIMENTAL> mean.
=head2 Utility Functions
=over
-=item C<legal_values> B<EXPERIMENTAL>
+=item C<legal_values>
+
+B<EXPERIMENTAL>
=over
=back
-=head2 Bug Creation and Modification
+=head2 Bug Information
=over
-=item C<get> B<EXPERIMENTAL>
+=item C<get>
+
+B<EXPERIMENTAL>
=over
=back
-=item C<get_history> B<UNSTABLE>
+=item C<get_history>
+
+B<UNSTABLE>
=over
The same as L</get>.
+=item B<History>
+
+=over
+
+=item Added in Bugzilla B<3.4>.
+
+=back
+
+=back
+
=back
-=item C<create> B<EXPERIMENTAL>
+=head2 Bug Creation and Modification
+
+=over
+
+=item C<create>
+
+B<EXPERIMENTAL>
=over
=back
-=item C<add_comment> B<EXPERIMENTAL>
+=item C<add_comment>
+
+B<EXPERIMENTAL>
=over
=back
+=item B<History>
+
+=over
+
+=item Added in Bugzilla B<3.2>.
+
+=back
+
=back
=head1 METHODS
-See L<Bugzilla::WebService> for a description of what B<STABLE>, B<UNSTABLE>,
-and B<EXPERIMENTAL> mean.
+See L<Bugzilla::WebService> for a description of how parameters are passed,
+and what B<STABLE>, B<UNSTABLE>, and B<EXPERIMENTAL> mean.
=over
-=item C<version> B<EXPERIMENTAL>
+=item C<version>
+
+B<STABLE>
=over
=back
-=item C<extensions> B<EXPERIMENTAL>
+=item C<extensions>
+
+B<EXPERIMENTAL>
=over
as values. One of the values that must be returned is the 'version' of the
extension
+=item B<History>
+
+=over
+
+=item Added in Bugzilla B<3.2>.
+
+=back
+
=back
-=item C<timezone> B<EXPERIMENTAL>
+=item C<timezone>
+
+B<STABLE>
=over
=item B<Returns>
-A hash with a single item, C<timezone>, that is the timezone as a
+A hash with a single item, C<timezone>, that is the timezone offset as a
string in (+/-)XXXX (RFC 2822) format.
=back
=head1 METHODS
-See L<Bugzilla::WebService> for a description of what B<STABLE>, B<UNSTABLE>,
-and B<EXPERIMENTAL> mean, and for more information about error codes.
+See L<Bugzilla::WebService> for a description of how parameters are passed,
+and what B<STABLE>, B<UNSTABLE>, and B<EXPERIMENTAL> mean.
=head2 List Products
=over
-=item C<get_selectable_products> B<UNSTABLE>
+=item C<get_selectable_products>
+
+B<EXPERIMENTAL>
=over
=back
-=item C<get_enterable_products> B<UNSTABLE>
+=item C<get_enterable_products>
+
+B<EXPERIMENTAL>
=over
=back
-=item C<get_accessible_products> B<UNSTABLE>
+=item C<get_accessible_products>
+
+B<UNSTABLE>
=over
=back
-=item C<get> B<UNSTABLE>
+=item C<get>
+
+B<EXPERIMENTAL>
=over
=head1 METHODS
-See L<Bugzilla::WebService> for a description of what B<STABLE>, B<UNSTABLE>,
-and B<EXPERIMENTAL> mean, and for more information about error codes.
+See L<Bugzilla::WebService> for a description of how parameters are passed,
+and what B<STABLE>, B<UNSTABLE>, and B<EXPERIMENTAL> mean.
=head2 Logging In and Out
=over
-=item C<login> B<EXPERIMENTAL>
+=item C<login>
+
+B<STABLE>
=over
=back
-=item C<logout> B<EXPERIMENTAL>
+=item C<logout>
+
+B<STABLE>
=over
=over
-=item C<offer_account_by_email> B<EXPERIMENTAL>
+=item C<offer_account_by_email>
+
+B<STABLE>
=over
=back
-=item C<create> B<EXPERIMENTAL>
+=item C<create>
+
+B<EXPERIMENTAL>
=over
possible, because that makes sure that the email address specified can
actually receive an email. This function does not check that.
+You must be logged in and have the C<editusers> privilege in order to
+call this function.
+
=item B<Params>
=over
=over
-=item C<get> B<UNSTABLE>
+=item C<get>
+
+B<UNSTABLE>
=over
administrator.
Logged-out users cannot use this argument, and an error will be thrown
-if they try.
+if they try. (This is to make it harder for spammers to harvest email
+addresses from Bugzilla, and also to enforce the user visibility
+restrictions that are implemented on some Bugzillas.)
=item C<include_fields> (array)
=back
+=item B<History>
+
+=over
+
+=item Added in Bugzilla B<3.4>.
+
+=back
+
=back
=back
#
# The Original Code is the Bugzilla Bug Tracking System.
#
-# The Initial Developer of the Original Code is Everything Solved.
-# Portions created by Everything Solved are Copyright (C) 2008
-# Everything Solved. All Rights Reserved.
+# The Initial Developer of the Original Code is Everything Solved, Inc.
+# Portions created by the Initial Developer are Copyright (C) 2008
+# the Initial Developer. All Rights Reserved.
#
-# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
+# Contributor(s):
+# Max Kanat-Alexander <mkanat@bugzilla.org>
package Bugzilla::WebService::Util;
use strict;
=head1 NAME
Bugzilla::WebService::Util - Utility functions used inside of the WebService
-code.
+code. These are B<not> functions that can be called via the WebService.
=head1 DESCRIPTION
projects / thirdparty / bugzilla.git / commitdiff
