sources.rest_api.typing

PaginatorTypeConfig Objects

class PaginatorTypeConfig(TypedDict)

[view_source]

type

noqa

PageNumberPaginatorConfig Objects

class PageNumberPaginatorConfig(PaginatorTypeConfig)

[view_source]

A paginator that uses page number-based pagination strategy.

OffsetPaginatorConfig Objects

class OffsetPaginatorConfig(PaginatorTypeConfig)

[view_source]

A paginator that uses offset-based pagination strategy.

HeaderLinkPaginatorConfig Objects

class HeaderLinkPaginatorConfig(PaginatorTypeConfig)

[view_source]

A paginator that uses the 'Link' header in HTTP responses for pagination.

JSONLinkPaginatorConfig Objects

class JSONLinkPaginatorConfig(PaginatorTypeConfig)

[view_source]

Locates the next page URL within the JSON response body. The key containing the URL can be specified using a JSON path.

JSONResponseCursorPaginatorConfig Objects

class JSONResponseCursorPaginatorConfig(PaginatorTypeConfig)

[view_source]

Uses a cursor parameter for pagination, with the cursor value found in the JSON response body.

AuthTypeConfig Objects

class AuthTypeConfig(TypedDict)

[view_source]

type

noqa

BearerTokenAuthConfig Objects

class BearerTokenAuthConfig(TypedDict)

[view_source]

Uses token for Bearer authentication in "Authorization" header.

type

noqa

ApiKeyAuthConfig Objects

class ApiKeyAuthConfig(AuthTypeConfig)

[view_source]

Uses provided api_key to create authorization data in the specified location (query, param, header, cookie) under specified name

HttpBasicAuthConfig Objects

class HttpBasicAuthConfig(AuthTypeConfig)

[view_source]

Uses HTTP basic authentication

ParamBindConfig Objects

class ParamBindConfig(TypedDict)

[view_source]

type

noqa

ProcessingSteps Objects

class ProcessingSteps(TypedDict)

[view_source]

filter

noqa: A003

map

noqa: A003

ResourceBase Objects

class ResourceBase(TResourceHintsBase)

[view_source]

Defines hints that may be passed to dlt.resource decorator