diff options
Diffstat (limited to 'Bugzilla/WebService.pm')
-rwxr-xr-x | Bugzilla/WebService.pm | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/Bugzilla/WebService.pm b/Bugzilla/WebService.pm index 9e100c12a..edb3bd1f9 100755 --- a/Bugzilla/WebService.pm +++ b/Bugzilla/WebService.pm @@ -45,3 +45,33 @@ sub make_response { } 1; + +__END__ + +=head1 NAME + +Bugzilla::WebSerice - The Web Service interface to Bugzilla + +=head1 DESCRIPTION + +This is the standard API for external programs that want to interact +with Bugzilla. It provides various methods in various modules. + +=head1 STABLE, EXPERIMENTAL, and UNSTABLE + +Methods are marked B<STABLE> if you can expect their parameters and +return values not to change between versions of Bugzilla. You are +best off always using methods marked B<STABLE>. We may add parameters +and additional items to the return values, but your old code will +always continue to work with any new changes we make. If we ever break +a B<STABLE> interface, we'll post a big notice in the Release Notes, +and it will only happen during a major new release. + +Methods (or parts of methods) are marked B<EXPERIMENTAL> if +we I<believe> they will be stable, but there's a slight chance that +small parts will change in the future. + +Certain parts of a method's description may be marked as B<UNSTABLE>, +in which case those parts are not guaranteed to stay the same between +Bugzilla versions. + |