sources.rest_api.typing
PaginatorTypeConfig Objects
class PaginatorTypeConfig(TypedDict)
type
noqa
PageNumberPaginatorConfig Objects
class PageNumberPaginatorConfig(PaginatorTypeConfig)
A paginator that uses page number-based pagination strategy.
OffsetPaginatorConfig Objects
class OffsetPaginatorConfig(PaginatorTypeConfig)
A paginator that uses offset-based pagination strategy.
HeaderLinkPaginatorConfig Objects
class HeaderLinkPaginatorConfig(PaginatorTypeConfig)
A paginator that uses the 'Link' header in HTTP responses for pagination.
JSONLinkPaginatorConfig Objects
class JSONLinkPaginatorConfig(PaginatorTypeConfig)
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)
Uses a cursor parameter for pagination, with the cursor value found in the JSON response body.
AuthTypeConfig Objects
class AuthTypeConfig(TypedDict)
type
noqa
BearerTokenAuthConfig Objects
class BearerTokenAuthConfig(TypedDict)
Uses token for Bearer authentication in "Authorization" header.
type
noqa
ApiKeyAuthConfig Objects
class ApiKeyAuthConfig(AuthTypeConfig)
Uses provided api_key to create authorization data in the specified location (query, param, header, cookie) under specified name
HttpBasicAuthConfig Objects
class HttpBasicAuthConfig(AuthTypeConfig)
Uses HTTP basic authentication
OAuth2ClientCredentialsConfig Objects
class OAuth2ClientCredentialsConfig(AuthTypeConfig)
Uses OAuth 2.0 client credential authorization
ParamBindConfig Objects
class ParamBindConfig(TypedDict)
type
noqa
ProcessingSteps Objects
class ProcessingSteps(TypedDict)
filter
noqa: A003
map
noqa: A003
ResourceBase Objects
class ResourceBase(TResourceHintsBase)
Defines hints that may be passed to dlt.resource decorator