rbtools.api.resource.hosting_service¶

Resource definitions for hosting services.

Classes

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

Bases: ItemResource

Item resource for hosting services.

This corresponds to Review Board`s Hosting Service Resource.

Added in version 6.0.

__firstlineno__ = 32¶

__static_attributes__ = ()¶

get_accounts(**kwargs: Unpack[HostingServiceAccountGetListParams]) → HostingServiceAccountListResource[source]¶

Get the hosting service account list resource.

Parameters:

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

Returns:

The hosting service account list resource.

Return type:

rbtools.api.resource.HostingServiceAccountListResource

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_repositories(**kwargs: Unpack[RepositoryGetListParams]) → RepositoryListResource[source]¶

Get the repositories that use this hosting service.

Parameters:

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

Returns:

The repository list.

Return type:

rbtools.api.resource.RepositoryListResource

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: str¶

The hosting service’s unique ID.

name: str¶

The name of the hosting service.

needs_authorization: bool¶

Whether an account must be authorized and linked to use this service.

plans: JSONDict¶

Information on account configuration plans supported by the service.

These correspond to the repository_plan field used when creating or updating a repository. This is not used for all services.

self_hosted: bool¶

Whether the service is meant to be self-hosted in the network.

supported_scmtools: list[str]¶

A list of repository types supported by the service.

Each of these is a registered SCMTool ID or human-readable name. Some of these may be obsolete and no longer supported by the service. See visible_scmtools.

supports_bug_trackers: bool¶

Whether this hosting service supports bug tracking.

supports_list_remote_repositories: bool¶

Whether remote repositories can be listed through the API.

supports_repositories: bool¶

Whether this hosting service supports repositories.

supports_two_factor_auth: bool¶

Whether two-factor authentication is supported when linking an account.

visible_scmtools: list[str]¶

The list of repository types that can be configured.

Each of these is a registered SCMTool ID or human-readable name.

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

Bases: ListResource[HostingServiceItemResource]

List resource for hosting services.

This corresponds to Review Board`s Hosting Service List Resource.

Added in version 6.0.

__annotations_cache__ = {}¶

__firstlineno__ = 138¶

__static_attributes__ = ()¶