<<

Bugzilla::Extension::EditComments::Webservice

NAME

Bugzilla::Extension::EditComments::Webservice - The EditComments WebServices API

DESCRIPTION

This module contains API methods that are useful to user's of bugzilla.mozilla.org.

METHODS

comments

EXPERIMENTAL

Description

This allows you to get the raw comment text about comments, given a list of comment ids.

REST

To get all comment text for a list of comment ids:

GET /bug/editcomments/comment?comment_ids=1234&comment_ids=5678...

To get comment text for a specific comment based on the comment ID:

GET /bug/editcomments/comment/<comment_id>

The returned data format is the same as below.

Params
comment_ids (required)

array An array of integer comment_ids. These comments will be returned individually, separate from any other comments in their respective bugs.

Returns

1 item is returned:

comments

Each individual comment requested in comment_ids is returned here, in a hash where the numeric comment id is the key, and the value is the comment's raw text.

Errors

In addition to standard Bug.get type errors, this method can throw the following additional errors:

110 (Comment Is Private)

You specified the id of a private comment in the comment_ids argument, and you are not in the "insider group" that can see private comments.

111 (Invalid Comment ID)

You specified an id in the comment_ids argument that is invalid--either you specified something that wasn't a number, or there is no comment with that id.

History
Added in BMO Bugzilla 4.2.

See Bugzilla::WebService for a description of how parameters are passed, and what STABLE, UNSTABLE, and EXPERIMENTAL mean.

<<