rbtools.api.resource.base_review_group¶

Base class for review group resources.

Classes

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

Bases: ItemResource

Base class for review group item resources.

Added in version 6.0.

__firstlineno__ = 25¶

__static_attributes__ = ()¶

absolute_url: str¶

The absolute URL to the group’s page on the site.

display_name: str¶

The human-readable name of the group.

extra_data: ResourceExtraDataField | None¶

Extra data as part of the review group.

id: int¶

The numeric ID of the review group.

invite_only: bool¶

Whether or not the group is invite-only.

An invite-only group is only accessible by members of the group.

mailing_list: str¶

The e-mail address of a mailing list for the group.

name: str¶

The short name of the group, used in the reviewer list and dashboard.

url: str¶

The URL to the group’s page on the site.

This is deprecated in favor of the absolute_url attribute.

visible: bool¶

Whether or not the group is visible to users who are not members.

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

Bases: Generic[TItemResource], ListResource[TItemResource]

List resource for review groups.

Added in version 6.0.

__firstlineno__ = 91¶

__static_attributes__ = ()¶

class rbtools.api.resource.base_review_group.ReviewGroupGetListParams[source]¶

Bases: BaseGetListParams

Params for the review group list GET operation.

Added in version 6.0.

__firstlineno__ = 68¶

__static_attributes__ = ()¶

displayname: bool¶

Specifies whether q should also match the display name.

invite_only: bool¶

Whether to limit results to accessible invite-only groups.

q: str¶

The string that the group name (or display name) must start with.

The display name will be included if the displayname parameter is True. This query is case-insensitive.

show_invisible: bool¶

Whether to include accessible invisible review groups in the results.