DeclarativeSource

An API source that extracts data according to its declarative components.

• type: object
• required: ["type","check","version"]

type

• Required: Yes
• type: string
• enum: ["DeclarativeSource"]

check

• Required: Yes

• anyOf:

  • Allowed type: CheckStream

• anyOf:

  • Allowed type: CheckDynamicStream

streams

• Required: No

• type: array

• items:

  • anyOf:

    • Allowed type: ConditionalStreams

  • anyOf:

    • Allowed type: DeclarativeStream

  • anyOf:

    • Allowed type: StateDelegatingStream

dynamic_streams

• Required: No

• type: array

• items:

  • Allowed type: DynamicDeclarativeStream

version

The version of the Airbyte CDK used to build and test the source.

• Required: Yes
• type: string

schemas

• Required: No
• Allowed type: Schemas

definitions

• Required: No
• type: object

spec

• Required: No
• Allowed type: Spec

concurrency_level

• Required: No
• Allowed type: ConcurrencyLevel

api_budget

• Required: No
• Allowed type: HTTPAPIBudget

stream_groups

Groups of streams that share a common resource and should not be read simultaneously. Each group defines a set of stream references and an action that controls how concurrent reads are managed. Only applies to ConcurrentDeclarativeSource.

• Required: No

• type: object

• additionalProperties:

  • Allowed type: StreamGroup

max_concurrent_async_job_count

Maximum number of concurrent asynchronous jobs to run. This property is only relevant for sources/streams that support asynchronous job execution through the AsyncRetriever (e.g. a report-based stream that initiates a job, polls the job status, and then fetches the job results). This is often set by the API's maximum number of concurrent jobs on the account level. Refer to the API's documentation for this information.

• Required: No
• type: ["integer","string"]

Examples:

3

{{ config['max_concurrent_async_job_count'] }}

metadata

For internal Airbyte use only - DO NOT modify manually. Used by consumers of declarative manifests for storing related metadata.

• Required: No
• type: object

description

A description of the connector. It will be presented on the Source documentation page.

• Required: No

• type: string

• anyOf:

  • required: ["streams"]

• anyOf:

  • required: ["dynamic_streams"]