cata_log_hub.api.v1.pages module

cata_log_hub.api.v1.pages.list_pages(order=[PageOrderChoices.DESC_CATALOG_ID, PageOrderChoices.NUMBER], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

List all pages.

Return type:

PaginationPage[Page]

Parameters:

• order (Annotated[list[PageOrderChoices], Query(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.pages.get_page(page_id, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

Get a single page.

Return type:

Page

Parameters:

• page_id (Annotated[int, Path(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.pages.download_page(page_id, filename=None, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

Download a single page.

Return type:

FileResponse

Parameters:

• page_id (Annotated[int, Path(PydanticUndefined)])

• filename (Annotated[str | None, Query(PydanticUndefined)])

• db_session (Session)

cata_log_hub.api.v1.pages.embed_page(page_id, filename=None, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))

Embed a single page.

Return type:

FileResponse

Parameters:

• page_id (Annotated[int, Path(PydanticUndefined)])

• filename (Annotated[str | None, Query(PydanticUndefined)])

• db_session (Session)