Feeds

add_feed `async`

add_feed(
    auth: Annotated[
        Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    body: FeedCreateBody,
) -> FeedResponse

Add a new feed with given details.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`body`	`FeedCreateBody`	the request body	required

Returns:

Type	Description
`FeedResponse`	the new feed

add_feed_depr `async`

add_feed_depr(
    auth: Annotated[
        Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    body: FeedCreateBody,
) -> FeedResponse

Deprecated. Add a new feed with given details using the old route.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`body`	`FeedCreateBody`	the request body	required

Returns:

Type	Description
`FeedResponse`	the added feed

cache_feeds `async`

cache_feeds(
    auth: Annotated[
        Auth, Depends(authorize(ALL, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    cache_feeds_scope: Annotated[
        str, Path(alias=cacheFeedsScope)
    ],
) -> FeedCacheResponse

Cache feeds based on a specific scope. NOT YET AVAILABLE!

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(ALL, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`cache_feeds_scope`	`Annotated[str, Path(alias=cacheFeedsScope)]`	the cache feeds scope	required

Returns:

Type	Description
`FeedCacheResponse`	the cache feeds

cache_feeds_depr `async`

cache_feeds_depr(
    auth: Annotated[
        Auth, Depends(authorize(ALL, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    cache_feeds_scope: Annotated[
        str, Path(alias=cacheFeedsScope)
    ],
) -> FeedCacheResponse

Cache feeds based on a specific scope.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(ALL, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`cache_feeds_scope`	`Annotated[str, Path(alias=cacheFeedsScope)]`	the cache feeds scope	required

Returns:

Type	Description
`FeedCacheResponse`	the feed cache

disable_feed `async`

disable_feed(
    auth: Annotated[
        Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    feed_id: Annotated[int, Path(alias=feedId)],
) -> FeedEnableDisableResponse

Deprecated. Disable a specific feed by its ID using the old route.

Returns:

Type	Description
`FeedEnableDisableResponse`	the disabled feed

enable_feed `async`

enable_feed(
    auth: Annotated[
        Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    feed_id: Annotated[int, Path(alias=feedId)],
) -> FeedEnableDisableResponse

Deprecated. Enable a specific feed by its ID using the old route.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))]`	user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	current database	required
`feed_id`	`Annotated[int, Path(alias=feedId)]`	feed id	required

Returns:

Type	Description
`FeedEnableDisableResponse`	the the enabled feed

fetch_data_from_all_feeds `async`

fetch_data_from_all_feeds(
    auth: Annotated[
        Auth, Depends(authorize(ALL, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
) -> FeedFetchResponse

Fetch data from all available feeds. NOT YET AVAILABLE!

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(ALL, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required

Returns:

Type	Description
`FeedFetchResponse`	the fetched data of all available feeds

fetch_data_from_all_feeds_depr `async`

fetch_data_from_all_feeds_depr(
    auth: Annotated[
        Auth, Depends(authorize(ALL, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
) -> FeedFetchResponse

Deprecated. Fetch data from all available feeds using the old route.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(ALL, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required

Returns:

Type	Description
`FeedFetchResponse`	the fetched data of all feeds

fetch_from_feed `async`

fetch_from_feed(
    auth: Annotated[
        Auth, Depends(authorize(ALL, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    feed_id: Annotated[int, Path(alias=feedId)],
) -> FeedFetchResponse

Fetch data from a specific feed by its ID. NOT YET AVAILABLE!

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(ALL, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`feed_id`	`Annotated[int, Path(alias=feedId)]`	the feed id	required

Returns:

Type	Description
`FeedFetchResponse`	the fetched feed data

fetch_from_feed_depr `async`

fetch_from_feed_depr(
    auth: Annotated[
        Auth, Depends(authorize(ALL, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    feed_id: Annotated[int, Path(alias=feedId)],
) -> FeedFetchResponse

Deprecated. Fetch data from a specific feed by its ID using the old route.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(ALL, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`feed_id`	`Annotated[int, Path(alias=feedId)]`	the feed id	required

Returns:

Type	Description
`FeedFetchResponse`	the fetched feed data

get_feed_details `async`

get_feed_details(
    auth: Annotated[Auth, Depends(authorize(HYBRID))],
    db: Annotated[Session, Depends(get_db)],
    feed_id: Annotated[int, Path(alias=feedId)],
) -> FeedResponse

Retrieve details of a specific feed by its ID.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(HYBRID))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`feed_id`	`Annotated[int, Path(alias=feedId)]`	the feed id	required

Returns:

Type	Description
`FeedResponse`	the details of a feed

get_feed_details_depr `async`

get_feed_details_depr(
    auth: Annotated[Auth, Depends(authorize(HYBRID))],
    db: Annotated[Session, Depends(get_db)],
    feed_id: Annotated[int, Path(alias=feedId)],
) -> FeedResponse

Deprecated. Retrieve details of a specific feed by its ID using the old route.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(HYBRID))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`feed_id`	`Annotated[int, Path(alias=feedId)]`	the feed id	required

Returns:

Type	Description
`FeedResponse`	the details of the feed

get_feeds `async`

get_feeds(
    auth: Annotated[Auth, Depends(authorize(HYBRID))],
    db: Annotated[Session, Depends(get_db)],
) -> list[FeedResponse]

Retrieve a list of all feeds.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(HYBRID))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required

Returns:

Type	Description
`list[FeedResponse]`	all feeds as a list

toggle_feed `async`

toggle_feed(
    auth: Annotated[
        Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    feed_id: Annotated[int, Path(alias=feedId)],
    body: FeedToggleBody,
) -> FeedEnableDisableResponse

Toggle the status of a feed between enabled and disabled.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`feed_id`	`Annotated[int, Path(alias=feedId)]`	the feed id	required
`body`	`FeedToggleBody`	the request body	required

Returns:

Type	Description
`FeedEnableDisableResponse`	the new status of the feed

update_feed `async`

update_feed(
    auth: Annotated[
        Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    feed_id: Annotated[int, Path(alias=feedId)],
    body: FeedUpdateBody,
) -> FeedResponse

Update an existing feed by its ID.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`feed_id`	`Annotated[int, Path(alias=feedId)]`	the feed id	required
`body`	`FeedUpdateBody`	the request body	required

Returns:

Type	Description
`FeedResponse`	the updated feed

update_feed_depr `async`

update_feed_depr(
    auth: Annotated[
        Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))
    ],
    db: Annotated[Session, Depends(get_db)],
    feed_id: Annotated[int, Path(alias=feedId)],
    body: FeedUpdateBody,
) -> FeedResponse

Deprecated. Update an existing feed by its ID using the old route.

Parameters:

Name	Type	Description	Default
`auth`	`Annotated[Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))]`	the user's authentification status	required
`db`	`Annotated[Session, Depends(get_db)]`	the current database	required
`feed_id`	`Annotated[int, Path(alias=feedId)]`	the feed id	required
`body`	`FeedUpdateBody`	the request body	required

Returns:

Type	Description
`FeedResponse`	the updated feed

Feeds

add_feed async

add_feed_depr async

cache_feeds async

cache_feeds_depr async

disable_feed async

enable_feed async

fetch_data_from_all_feeds async

fetch_data_from_all_feeds_depr async

fetch_from_feed async

fetch_from_feed_depr async

get_feed_details async

get_feed_details_depr async

get_feeds async

toggle_feed async

update_feed async

update_feed_depr async

add_feed `async`

add_feed_depr `async`

cache_feeds `async`

cache_feeds_depr `async`

disable_feed `async`

enable_feed `async`

fetch_data_from_all_feeds `async`

fetch_data_from_all_feeds_depr `async`

fetch_from_feed `async`

fetch_from_feed_depr `async`

get_feed_details `async`

get_feed_details_depr `async`

get_feeds `async`

toggle_feed `async`

update_feed `async`

update_feed_depr `async`