rbtools.api.resource.review_request_draft¶

Resource definitions for review request drafts.

Classes

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

Bases: BaseReviewRequestItemResource

Resource for review request drafts.

This corresponds to Review Board’s Review Request Draft Resource.

Added in version 6.0.

__firstlineno__ = 34¶

__static_attributes__ = ()¶

changedescription: str¶

A description of what changes are being made in this update.

changedescription_text_type: TextType¶

The current or forced text type for the changedescription field.

get_draft_diffs(**kwargs: Unpack[BaseGetListParams]) → DiffListResource[source]¶

Get the draft diffs list resource.

Parameters:

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

Returns:

The draft diff list resource.

Return type:

rbtools.api.resource.DiffListResource

Raises:

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

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

get_draft_file_attachments(**kwargs: Unpack[BaseGetListParams]) → DraftFileAttachmentListResource[source]¶

Get the draft file attachments list resource.

Parameters:

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

Returns:

The draft file attachment list resource.

Return type:

rbtools.api.resource.DraftFileAttachmentListResource

Raises:

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

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

get_draft_screenshots(**kwargs: Unpack[BaseGetListParams]) → DraftScreenshotListResource[source]¶

Get the draft screenshots list resource.

Parameters:

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

Returns:

The draft screenshot list resource.

Return type:

rbtools.api.resource.DraftScreenshotListResource

Raises:

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

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

get_review_request(**kwargs: Unpack[BaseGetParams]) → ReviewRequestItemResource[source]¶

Get the review request for this draft.

Parameters:

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

Returns:

The review request item resource.

Return type:

rbtools.api.resource.ReviewRequestItemResource

Raises:

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

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

id: int¶

The numeric ID of the draft.

public: bool¶

Whether or not the draft is public.

This will always be false up until the draft is published. At that point, the draft is deleted.