rbtools.api.resource.search¶

Resource definition for the search resource.

Classes

class rbtools.api.resource.search.SearchGetParams[source]¶

Bases: TypedDict

Params for the search GET operation.

Added in version 6.0.

__firstlineno__ = 17¶

__static_attributes__ = ()¶

fullname: bool¶

Whether to include users whose full name includes the search text.

id: int¶

A specific review request ID to search for.

max_results: int¶

The maximum number of results to return for each matching object type.

By default, this is 25. There is an upper limit of 200.

q: str¶

The text to search for.

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

Bases: ItemResource

Resource for performing searches.

This corresponds to Review Board’s Search Resource.

Added in version 6.0.

__firstlineno__ = 43¶

__static_attributes__ = ()¶

groups: JSONList¶

The list of matching review groups.

review_requests: JSONList¶

The list of matching review requests.

users: JSONList¶

The list of matching users.