kavita_client.api.annotation.get_api_annotation_annotation_id

Module Contents

Functions

asyncio	Returns the Annotation by Id. User must have access to annotation.
asyncio_detailed	Returns the Annotation by Id. User must have access to annotation.
sync	Returns the Annotation by Id. User must have access to annotation.
sync_detailed	Returns the Annotation by Id. User must have access to annotation.

API

async kavita_client.api.annotation.get_api_annotation_annotation_id.asyncio(annotation_id: int, *, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.models.annotation_dto.AnnotationDto | None

Returns the Annotation by Id. User must have access to annotation.

Args:

annotation_id (int):

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:

AnnotationDto

async kavita_client.api.annotation.get_api_annotation_annotation_id.asyncio_detailed(annotation_id: int, *, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[kavita_client.models.annotation_dto.AnnotationDto]

Returns the Annotation by Id. User must have access to annotation.

Args:

annotation_id (int):

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[AnnotationDto]

kavita_client.api.annotation.get_api_annotation_annotation_id.sync(annotation_id: int, *, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.models.annotation_dto.AnnotationDto | None

Returns the Annotation by Id. User must have access to annotation.

Args:

annotation_id (int):

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:

AnnotationDto

kavita_client.api.annotation.get_api_annotation_annotation_id.sync_detailed(annotation_id: int, *, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[kavita_client.models.annotation_dto.AnnotationDto]

Returns the Annotation by Id. User must have access to annotation.

Args:

annotation_id (int):

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[AnnotationDto]