Skip to content

bugzilla
bugzilla
Commit be891c97 authored by Frédéric Buclin's avatar Frédéric Buclin
Browse files
Options

Bug 605573: List all available WebService methods at the top of the POD

r/a=mkanat
parent a56886c1
Hide whitespace changes
Inline Side-by-side
Showing with 35 additions and 77 deletions
Bugzilla/WebService/Bug.pm
View file @ be891c97
......@@ -963,11 +963,9 @@ or get information about bugs that have already been filed.
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
=head1 Utility Functions
=over
=item C<fields>
=head2 fields
B<UNSTABLE>
......@@ -1164,7 +1162,7 @@ You specified an invalid field name or id.
=back
=item C<legal_values>
=head2 legal_values
B<DEPRECATED> - Use L</fields> instead.
......@@ -1208,15 +1206,9 @@ You specified a field that doesn't exist or isn't a drop-down field.
=back
=head1 Bug Information
=back
=head2 Bug Information
=over
=item C<attachments>
=head2 attachments
B<EXPERIMENTAL>
......@@ -1388,7 +1380,7 @@ C<summary>.
=back
=item C<comments>
=head2 comments
B<STABLE>
......@@ -1533,7 +1525,7 @@ C<creator>.
=back
=item C<get>
=head2 get
B<STABLE>
......@@ -1878,7 +1870,7 @@ and all custom fields.
=back
=item C<history>
=head2 history
B<EXPERIMENTAL>
......@@ -1985,7 +1977,7 @@ The same as L</get>.
=back
=item C<search>
=head2 search
B<UNSTABLE>
......@@ -2178,14 +2170,9 @@ in Bugzilla B<4.0>.
=back
=back
=head2 Bug Creation and Modification
=over
=head1 Bug Creation and Modification
=item C<create>
=head2 create
B<STABLE>
......@@ -2349,7 +2336,7 @@ argument.
=back
=item C<add_attachment>
=head2 add_attachment
B<UNSTABLE>
......@@ -2455,7 +2442,7 @@ You did not specify a value for the C<summary> argument.
=back
=item C<add_comment>
=head2 add_comment
B<STABLE>
......@@ -2546,7 +2533,7 @@ code of 32000.
=back
=item C<update>
=head2 update
B<UNSTABLE>
......@@ -2938,7 +2925,7 @@ which we won't even know about until after we do QA for 4.0.
=back
=item C<update_see_also>
=head2 update_see_also
B<EXPERIMENTAL>
......@@ -3049,6 +3036,3 @@ this bug.
=back
=back
=back
Bugzilla/WebService/Bugzilla.pm
View file @ be891c97
......@@ -98,9 +98,7 @@ This provides functions that tell you about Bugzilla in general.
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>
=head2 version
B<STABLE>
......@@ -121,7 +119,7 @@ string.
=back
=item C<extensions>
=head2 extensions
B<EXPERIMENTAL>
......@@ -166,7 +164,7 @@ extensions depended on the directory they were in on the Bugzilla server.
=back
=item C<timezone>
=head2 timezone
B<DEPRECATED> This method may be removed in a future version of Bugzilla.
Use L</time> instead.
......@@ -196,7 +194,7 @@ string in (+/-)XXXX (RFC 2822) format.
=back
=item C<time>
=head2 time
B<STABLE>
......@@ -270,6 +268,3 @@ local timezone.
=back
=back
=back
Bugzilla/WebService/Product.pm
View file @ be891c97
......@@ -97,11 +97,9 @@ get information about them.
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
=head1 List Products
=over
=item C<get_selectable_products>
=head2 get_selectable_products
B<EXPERIMENTAL>
......@@ -122,7 +120,7 @@ ids.
=back
=item C<get_enterable_products>
=head2 get_enterable_products
B<EXPERIMENTAL>
......@@ -144,7 +142,7 @@ ids.
=back
=item C<get_accessible_products>
=head2 get_accessible_products
B<UNSTABLE>
......@@ -166,7 +164,7 @@ ids.
=back
=item C<get>
=head2 get
B<EXPERIMENTAL>
......@@ -200,6 +198,3 @@ is returned.
=item B<Errors> (none)
=back
=back
Bugzilla/WebService/User.pm
View file @ be891c97
......@@ -277,11 +277,9 @@ log in/out using an existing account.
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
=head1 Logging In and Out
=over
=item C<login>
=head2 login
B<STABLE>
......@@ -344,7 +342,7 @@ A login or password parameter was not provided.
=back
=item C<logout>
=head2 logout
B<STABLE>
......@@ -362,13 +360,9 @@ Log out the user. Does nothing if there is no user logged in.
=back
=back
=head2 Account Creation
=over
=head1 Account Creation
=item C<offer_account_by_email>
=head2 offer_account_by_email
B<STABLE>
......@@ -409,7 +403,7 @@ An account with that email address already exists in Bugzilla.
=back
=item C<create>
=head2 create
B<STABLE>
......@@ -472,13 +466,9 @@ password is under three characters.)
=back
=back
=head2 User Info
=over
=head1 User Info
=item C<get>
=head2 get
B<STABLE>
......@@ -622,5 +612,3 @@ function.
=back
=back
=back
Bugzilla/WebService/Util.pm
View file @ be891c97
......@@ -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
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment