Skip to content

Feeds

add_feed async 

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

Add a new feed with given details.

Input:

  • the user's authentification status

  • the current database

  • the request body

Output:

  • the new feed

add_feed_depr async 

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

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

Input:

  • the user's authentification status

  • the current database

  • the request body

Output:

  • the added feed

cache_feeds async 

cache_feeds(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.ALL, [Permission.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!

Input:

  • the user's authentification status

  • the current database

  • the cache feeds scope

Output:

  • the cache feeds

cache_feeds_depr async 

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

Cache feeds based on a specific scope.

Input:

  • the user's authentification status

  • the current database

  • the cache feeds scope

Output:

  • the feed cache

disable_feed async 

disable_feed(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.HYBRID, [Permission.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.

Input:

  • the user's authentification status

  • the current database

  • the feed id

Output:

  • the disabled feed

enable_feed async 

enable_feed(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.HYBRID, [Permission.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.

Input:

  • the user's authentification status

  • the current database

  • the feed id

Output:

  • the the enabled feed

fetch_data_from_all_feeds async 

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

Fetch data from all available feeds. NOT YET AVAILABLE!

Input:

  • the user's authentification status

  • the current database

Output:

  • 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(
                AuthStrategy.ALL, [Permission.SITE_ADMIN]
            )
        ),
    ],
    db: Annotated[Session, Depends(get_db)],
) -> FeedFetchResponse

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

Input:

  • the user's authentification status

  • the current database

Output:

  • the fetched data of all feeds

fetch_from_feed async 

fetch_from_feed(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.ALL, [Permission.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!

Input:

  • the user's authentification status

  • the current database

  • the feed id

Output:

  • the fetched feed data

fetch_from_feed_depr async 

fetch_from_feed_depr(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.ALL, [Permission.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.

Input:

  • the user's authentification status

  • the current database

  • the feed id

Output:

  • the fetched feed data

get_feed_details async 

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

Retrieve details of a specific feed by its ID.

Input:

  • the user's authentification status

  • the current database

  • the feed id

Output:

  • the details of a feed

get_feed_details_depr async 

get_feed_details_depr(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.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.

Input:

  • the user's authentification status

  • the current database

  • the feed id

Output:

  • the details of the feed

get_feeds async 

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

Retrieve a list of all feeds.

Input:

  • the user's authentification status

  • the current database

Output:

  • all feeds as a list

toggle_feed async 

toggle_feed(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.HYBRID, [Permission.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.

Input:

  • the user's authentification status

  • the current database

  • the feed id

  • the request body

Output:

  • the new status of the feed

update_feed async 

update_feed(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.HYBRID, [Permission.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.

Input:

  • the user's authentification status

  • the current database

  • the feed id

  • the request body

Output:

  • the updated feed

update_feed_depr async 

update_feed_depr(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.HYBRID, [Permission.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.

Input:

  • the user's authentification status

  • the current database

  • the feed id

  • the request body

Output:

  • the updated feed