cata_log_hub.api.v1.providers module
- cata_log_hub.api.v1.providers.list_providers(order=[ProviderOrderChoices.CLASS_UID], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
List all providers.
- Return type:
PaginationPage[Provider]- Parameters:
order (Annotated[list[ProviderOrderChoices], Query(PydanticUndefined)])
db_session (Session)
- cata_log_hub.api.v1.providers.list_available_providers(query=None, region=None)[source]
List all available providers.
- Return type:
PaginationPage[type[Provider]]- Parameters:
query (Annotated[str | None, StringConstraints(strip_whitespace=True, to_upper=None, to_lower=True, strict=None, min_length=None, max_length=None, pattern=None, ascii_only=None), 'Filter by text (case-insensitive)'])
region (Annotated[str | None, StringConstraints(strip_whitespace=True, to_upper=None, to_lower=True, strict=None, min_length=None, max_length=None, pattern=None, ascii_only=None), 'Filter by region local name (case-insensitive)'])
- cata_log_hub.api.v1.providers.post_provider(new_provider, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Set up a new provider.
- Return type:
- Parameters:
new_provider (NewProvider)
db_session (Session)
- cata_log_hub.api.v1.providers.patch_provider(provider_id, provider_update, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Update a provider.
- Return type:
- Parameters:
provider_update (ProviderUpdate)
db_session (Session)
- cata_log_hub.api.v1.providers.get_provider(provider_id, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Get a single provider.
- cata_log_hub.api.v1.providers.get_available_provider(provider_class_uid)[source]
Get a single provider.
- cata_log_hub.api.v1.providers.delete_provider(provider_id, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Delete a single provider. This also deletes all its catalogs and their pages.
- cata_log_hub.api.v1.providers.list_provider_catalogs(provider_id, order=[CatalogOrderChoices.DESC_CREATED_AT], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
List all catalogs of a provider.
- cata_log_hub.api.v1.providers.get_latest_provider_catalog(provider_id, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Get the latest catalog of a provider.
- cata_log_hub.api.v1.providers.download_latest_provider_catalog(provider_id, filename=None, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Download the latest catalog of a provider as pdf.
- cata_log_hub.api.v1.providers.embed_latest_provider_catalog(provider_id, filename=None, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Embed the latest catalog of a provider as pdf.
- cata_log_hub.api.v1.providers.list_latest_provider_catalog_pages(provider_id, order=[PageOrderChoices.NUMBER], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Get the pages of the latest catalog of a provider.
- cata_log_hub.api.v1.providers.get_latest_provider_catalog_page(provider_id, page_number, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Get the pages of the latest catalog of a provider.
- cata_log_hub.api.v1.providers.download_latest_provider_catalog_page(provider_id, page_number, filename=None, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Download a single page of the latest catalog of a provider.
- cata_log_hub.api.v1.providers.embed_latest_provider_catalog_page(provider_id, page_number, filename=None, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Embed a single page of the latest catalog of a provider.
- cata_log_hub.api.v1.providers.list_provider_current_catalogs(provider_id, order=[CatalogOrderChoices.DESC_CREATED_AT], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
List all current catalogs of a provider.
- cata_log_hub.api.v1.providers.list_provider_preview_catalogs(provider_id, order=[CatalogOrderChoices.DESC_CREATED_AT], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
List all preview catalogs of a provider.
- cata_log_hub.api.v1.providers.list_provider_outdated_catalogs(provider_id, order=[CatalogOrderChoices.DESC_CREATED_AT], db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
List all outdated catalogs of a provider.
- cata_log_hub.api.v1.providers.post_provider_job_run(provider_id, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Run the providers job to update its catalog.
- cata_log_hub.api.v1.providers.post_provider_add_job(provider_id, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Add the provider’s job.
- cata_log_hub.api.v1.providers.post_provider_remove_job(provider_id, db_session=Depends(dependency=<function get_db_session>, use_cache=True, scope=None))[source]
Remove the provider’s job.