Bug 505490: Make Bug.comments take an "ids" argument instead of a "comment_ids" argument

Patch by Max Kanat-Alexander <mkanat@bugzilla.org> r=LpSolit, a=mkanat


git-svn-id: svn://10.0.0.236/branches/BUGZILLA-3_4-BRANCH@257749 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
mkanat%bugzilla.org 2009-07-21 18:39:49 +00:00
parent 17c80cfdd3
commit 8293d263bf

View File

@ -72,15 +72,15 @@ BEGIN {
###########
sub comments {
my ($self, $params) = validate(@_, 'bug_ids', 'comment_ids');
my ($self, $params) = validate(@_, 'ids', 'comment_ids');
if (!(defined $params->{bug_ids} || defined $params->{comment_ids})) {
if (!(defined $params->{ids} || defined $params->{comment_ids})) {
ThrowCodeError('params_required',
{ function => 'Bug.comments',
params => ['bug_ids', 'comment_ids'] });
params => ['ids', 'comment_ids'] });
}
my $bug_ids = $params->{bug_ids} || [];
my $bug_ids = $params->{ids} || [];
my $comment_ids = $params->{comment_ids} || [];
my $dbh = Bugzilla->dbh;
@ -584,7 +584,7 @@ and/or comment ids.
=item B<Params>
B<Note>: At least one of C<bug_ids> or C<comment_ids> is required.
B<Note>: At least one of C<ids> or C<comment_ids> is required.
In addition to the parameters below, this method also accepts the
standard L<include_fields|Bugzilla::WebService/include_fields> and
@ -592,7 +592,7 @@ L<exclude_fields|Bugzilla::WebService/exclude_fields> arguments.
=over
=item C<bug_ids>
=item C<ids>
C<array> An array that can contain both bug IDs and bug aliases.
All of the comments (that are visible to you) will be returned for the
@ -607,7 +607,7 @@ respective bugs.
=item C<new_since>
C<dateTime> If specified, the method will only return comments I<newer>
than this time. This only affects comments returned from the C<bug_ids>
than this time. This only affects comments returned from the C<ids>
argument. You will always be returned all comments you request in the
C<comment_ids> argument, even if they are older than this date.
@ -621,13 +621,13 @@ Two items are returned:
=item C<bugs>
This is used for bugs specified in C<bug_ids>. This is a hash,
This is used for bugs specified in C<ids>. This is a hash,
where the keys are the numeric ids of the bugs, and the value is
a hash with a single key, C<comments>, which is an array of comments.
(The format of comments is described below.)
Note that any individual bug will only be returned once, so if you
specify an id multiple times in C<bug_ids>, it will still only be
specify an id multiple times in C<ids>, it will still only be
returned once.
=item C<comments>