rbtools.api.resource.change¶

Resource definitions for change descriptions.

Classes

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

Bases: ItemResource

Item resource for review request changes.

This corresponds to Review Board’s Change Resource.

Added in version 6.0.

__firstlineno__ = 62¶

__static_attributes__ = ()¶

fields_changed: Mapping[str, ChangedField]¶

The fields that were changed.

id: int¶

The numeric ID of the change description.

text: str¶

The description of the text written by the submitter.

text_type: TextType¶

The text type for the text attribute.

timestamp: str¶

The date and time that the change was made, in ISO-8601 format.

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

Bases: ListResource[ChangeItemResource]

List resource for review request changes.

This corresponds to Review Board’s Change List Resource.

Added in version 6.0.

__annotations_cache__ = {}¶

__firstlineno__ = 92¶

__static_attributes__ = ()¶

class rbtools.api.resource.change.ChangedField[source]¶

Bases: TypedDict

Definition for a changed field.

Added in version 6.0.

__firstlineno__ = 26¶

__static_attributes__ = ()¶

added: ForwardRef('NotRequired[JSONValue]', module='rbtools.api.resource.change', owner=<class 'rbtools.api.resource.change.ChangedField'>)¶

Items that were added to the field.

The particular value of this is dependent on the type of the field. See the change resource documentation for the Review Board Web API for details.

new: ForwardRef('NotRequired[JSONValue]', module='rbtools.api.resource.change', owner=<class 'rbtools.api.resource.change.ChangedField'>)¶

The new value of the field.

The particular value of this is dependent on the type of the field. See the change resource documentation for the Review Board Web API for details.

old: ForwardRef('NotRequired[JSONValue]', module='rbtools.api.resource.change', owner=<class 'rbtools.api.resource.change.ChangedField'>)¶

The old value of the field.

The particular value of this is dependent on the type of the field. See the change resource documentation for the Review Board Web API for details.

removed: ForwardRef('NotRequired[JSONValue]', module='rbtools.api.resource.change', owner=<class 'rbtools.api.resource.change.ChangedField'>)¶

Items that were removed from the field.

The particular value of this is dependent on the type of the field. See the change resource documentation for the Review Board Web API for details.