-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
spec.yaml
133 lines (133 loc) · 4.36 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
documentationUrl: https://docs.airbyte.com/integrations/sources/salesforce
connectionSpecification:
$schema: http://json-schema.org/draft-07/schema#
title: Salesforce Source Spec
type: object
required:
- client_id
- client_secret
- refresh_token
additionalProperties: true
properties:
is_sandbox:
title: Sandbox
description: >-
Toggle if you're using a <a
href="https://help.salesforce.com/s/articleView?id=sf.deploy_sandboxes_parent.htm&type=5">Salesforce Sandbox</a>
type: boolean
default: false
order: 1
auth_type:
type: string
const: Client
client_id:
title: Client ID
description: Enter your Salesforce developer application's <a
href="https://developer.salesforce.com/forums/?id=9062I000000DLgbQAG">Client ID</a>
type: string
order: 2
client_secret:
title: Client Secret
description: Enter your Salesforce developer application's <a
href="https://developer.salesforce.com/forums/?id=9062I000000DLgbQAG">Client secret</a>
type: string
airbyte_secret: true
order: 3
refresh_token:
title: Refresh Token
description: >-
Enter your application's <a
href="https://developer.salesforce.com/docs/atlas.en-us.mobile_sdk.meta/mobile_sdk/oauth_refresh_token_flow.htm">Salesforce Refresh Token</a> used for Airbyte to access your Salesforce account.
type: string
airbyte_secret: true
order: 4
start_date:
title: Start Date
description: >-
Enter the date (or date-time) in the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. Airbyte will replicate the data updated on and after this date. If this field is blank, Airbyte will replicate the data for last two years.
type: string
pattern: >-
^([0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)?)$
pattern_descriptor: "YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ"
examples:
- "2021-07-25"
- "2021-07-25T00:00:00Z"
format: date-time
order: 5
force_use_bulk_api:
title: Force to use BULK API
type: boolean
description: Toggle to use Bulk API (this might cause empty fields for some streams)
default: false
order: 6
streams_criteria:
type: array
order: 7
items:
type: object
required:
- criteria
- value
properties:
criteria:
type: string
title: Search criteria
enum:
- starts with
- ends with
- contains
- exacts
- starts not with
- ends not with
- not contains
- not exacts
order: 1
default: contains
value:
type: string
title: Search value
order: 2
title: Filter Salesforce Objects
description: Add filters to select only required stream based on `SObject` name. Use this field to filter which tables are displayed by this connector. This is useful if your Salesforce account has a large number of tables (>1000), in which case you may find it easier to navigate the UI and speed up the connector's performance if you restrict the tables displayed by this connector.
advanced_auth:
auth_flow_type: oauth2.0
predicate_key:
- auth_type
predicate_value: Client
oauth_config_specification:
oauth_user_input_from_connector_config_specification:
type: object
additionalProperties: false
properties:
is_sandbox:
type: boolean
path_in_connector_config:
- is_sandbox
complete_oauth_output_specification:
type: object
additionalProperties: false
properties:
refresh_token:
type: string
path_in_connector_config:
- refresh_token
complete_oauth_server_input_specification:
type: object
additionalProperties: false
properties:
client_id:
type: string
client_secret:
type: string
complete_oauth_server_output_specification:
type: object
additionalProperties: false
properties:
client_id:
type: string
path_in_connector_config:
- client_id
client_secret:
type: string
path_in_connector_config:
- client_secret