rbtools.api.resource.review¶

Resource definitions for reviews.

Classes

class rbtools.api.resource.review.AllReviewsGetListParams[source]¶

Bases: BaseGetListParams

Params for the all reviews list resource GET operation.

Added in version 6.0.

__firstlineno__ = 63¶

__static_attributes__ = ()¶

last_updated_from: str¶

The earliest date/time the review could be last updated.

This is compared against the review’s timestamp field. This must be a valid ISO-8601 date/time format.

last_updated_to: str¶

The latest date/time the review could be last updated.

This is compared against the review’s timestamp field. This must be a valid ISO-8601 date/time format.

public: bool¶

Whether to filter for public (published) reviews.

If not set, both published and accessible unpublished reviews will be included.

repository: str¶

The repository name that the review requests of the reviews must be on.

review_group: str¶

The group name of users that the reviews must be owned by.

user: str¶

The username of the user that the reviews must be owned by.

class rbtools.api.resource.review.ReviewItemResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, **kwargs)[source]¶

Bases: BaseReviewItemResource

Item resource for reviews.

This corresponds to Review Board’s Review Resource.

Added in version 6.0.

__firstlineno__ = 28¶

__static_attributes__ = ()¶

get_replies(**kwargs: Unpack[BaseGetListParams]) → ReviewReplyListResource[source]¶

Get the replies to this review.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The review reply list resource.

Return type:

rbtools.api.resource.ReviewReplyListResource

Raises:

• rbtools.api.errors.APIError – The Review Board API returned an error.

• rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

class rbtools.api.resource.review.ReviewListResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, item_mime_type: str | None = None, **kwargs)[source]¶

Bases: ListResource[ReviewItemResource]

List resource for reviews.

This corresponds to Review Board’s Review List Resource.

Added in version 6.0.

__firstlineno__ = 98¶

__static_attributes__ = ()¶

get_review_draft(**kwargs: Unpack[BaseGetParams]) → ReviewItemResource[source]¶

Get the review draft, if one exists.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The review item resource.

Return type:

rbtools.api.resource.ReviewItemResource

Raises:

• rbtools.api.errors.APIError – The Review Board API returned an error.

• rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.