kavita_client.api.search.get_api_search_search

Module Contents

Functions

asyncio	Searches against different entities in the system against a query string
asyncio_detailed	Searches against different entities in the system against a query string
sync	Searches against different entities in the system against a query string
sync_detailed	Searches against different entities in the system against a query string

API

async kavita_client.api.search.get_api_search_search.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, query_string: str | kavita_client.types.Unset = UNSET, include_chapter_and_files: bool | kavita_client.types.Unset = True) → kavita_client.models.search_result_group_dto.SearchResultGroupDto | None

Searches against different entities in the system against a query string

Args:

query_string (str | Unset): include_chapter_and_files (bool | Unset): Default: True.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

SearchResultGroupDto

async kavita_client.api.search.get_api_search_search.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, query_string: str | kavita_client.types.Unset = UNSET, include_chapter_and_files: bool | kavita_client.types.Unset = True) → kavita_client.types.Response[kavita_client.models.search_result_group_dto.SearchResultGroupDto]

Searches against different entities in the system against a query string

Args:

query_string (str | Unset): include_chapter_and_files (bool | Unset): Default: True.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[SearchResultGroupDto]

kavita_client.api.search.get_api_search_search.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, query_string: str | kavita_client.types.Unset = UNSET, include_chapter_and_files: bool | kavita_client.types.Unset = True) → kavita_client.models.search_result_group_dto.SearchResultGroupDto | None

Searches against different entities in the system against a query string

Args:

query_string (str | Unset): include_chapter_and_files (bool | Unset): Default: True.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

SearchResultGroupDto

kavita_client.api.search.get_api_search_search.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, query_string: str | kavita_client.types.Unset = UNSET, include_chapter_and_files: bool | kavita_client.types.Unset = True) → kavita_client.types.Response[kavita_client.models.search_result_group_dto.SearchResultGroupDto]

Searches against different entities in the system against a query string

Args:

query_string (str | Unset): include_chapter_and_files (bool | Unset): Default: True.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[SearchResultGroupDto]