-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
spec.yaml
78 lines (78 loc) · 2.97 KB
/
spec.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
documentationUrl: https://docs.airbyte.com/integrations/sources/stripe
connectionSpecification:
$schema: http://json-schema.org/draft-07/schema#
title: Stripe Source Spec
type: object
required:
- client_secret
- account_id
properties:
account_id:
type: string
title: Account ID
description: >-
Your Stripe account ID (starts with 'acct_', find yours <a
href="https://dashboard.stripe.com/settings/account">here</a>).
order: 0
client_secret:
type: string
title: Secret Key
description: >-
Stripe API key (usually starts with 'sk_live_'; find yours <a
href="https://dashboard.stripe.com/apikeys">here</a>).
airbyte_secret: true
order: 1
start_date:
type: string
title: Replication start date
pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
description: >-
UTC date and time in the format 2017-01-25T00:00:00Z. Only data generated
after this date will be replicated.
default: "2017-01-25T00:00:00Z"
examples:
- "2017-01-25T00:00:00Z"
format: date-time
order: 2
lookback_window_days:
type: integer
title: Lookback Window in days
default: 0
minimum: 0
description: >-
When set, the connector will always re-export data from the past N days,
where N is the value set here. This is useful if your data is frequently updated
after creation. The Lookback Window only applies to streams that do not support event-based incremental syncs: Events,
SetupAttempts, ShippingRates, BalanceTransactions, Files, FileLinks, Refunds. More info <a
href="https://docs.airbyte.com/integrations/sources/stripe#requirements">here</a>
order: 3
slice_range:
type: integer
title: Data request time increment in days
default: 365
minimum: 1
examples: [1, 3, 10, 30, 180, 360]
description: >-
The time increment used by the connector when requesting data from the Stripe API. The bigger the value is,
the less requests will be made and faster the sync will be. On the other hand, the more seldom
the state is persisted.
order: 4
num_workers:
type: integer
title: Number of concurrent workers
minimum: 1
maximum: 20
default: 10
examples: [1, 2, 3]
description: >-
The number of worker thread to use for the sync.
The performance upper boundary depends on call_rate_limit setting and type of account.
order: 5
call_rate_limit:
type: integer
title: Max number of API calls per second
examples: [25, 100]
description: >-
The number of API calls per second that you allow connector to make. This value can not be bigger than real
API call rate limit (https://stripe.com/docs/rate-limits). If not specified the default maximum is 25 and 100
calls per second for test and production tokens respectively.