rbtools.api.resource.repository_branch¶

Resource definitions for repository branches.

Classes

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

Bases: ItemResource

Item resource for a repository branch.

There’s no MIME type associated with this because individual branches do not have their own endpoint.

Added in version 6.0.

__firstlineno__ = 22¶

__static_attributes__ = ()¶

commit: str¶

The revision identifier of the commit at the branch head.

The format depends on the repository type (it may be a number, SHA-1 hash, or some other type). This should be treated as a relatively opaque value, but can be used as the start parameter to the repository commits resource.

default: bool¶

Whether this branch is the “tip” of the repository.

This represents “master” or “main” for Git repositories, “trunk” for Subversion, etc.

id: str¶

The ID of the branch.

This is specific to the type of repository.

name: str¶

The name of the branch.

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

Bases: ListResource[RepositoryBranchItemResource]

List resource for repository branches.

This corresponds to Review Board’s Repository Branches Resource.

Added in version 6.0.

__firstlineno__ = 59¶

__static_attributes__ = ()¶