rbtools.api.resource.repository_commit¶

Resource definitions for repository commits.

Classes

class rbtools.api.resource.repository_commit.RepositoryCommitGetListParams[source]¶

Bases: BaseGetParams

Parameters for the repository commit list GET operation.

Added in version 6.0.

__firstlineno__ = 59¶

__static_attributes__ = ()¶

branch: str¶

The branch name to fetch commits for.

start: str¶

The commit ID to start at.

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

Bases: ItemResource

Item resource for a repository commit.

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

Added in version 6.0.

__firstlineno__ = 23¶

__static_attributes__ = ()¶

author_name: str¶

The real name or username of the author who made the commit.

date: str¶

The date and time of the commit in ISO-8601 format.

id: str¶

The revision identifier of the commit.

The format depends on the repository type (it may be a number, SHA-1 hash, or some other type). This should be treated as relatively opaque.

message: str¶

The commit message, if any.

parent: str¶

The revision of the parent commit.

This may be an empty string if this is the first revision in the commit history for a repository or branch.

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

Bases: ListResource[RepositoryCommitItemResource]

Resource for the repository commits API.

This corresponds to Review Board’s Repository Commits Resource.

Added in version 6.0.

__firstlineno__ = 73¶

__static_attributes__ = ()¶