-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
spec.json
121 lines (121 loc) · 4.18 KB
/
spec.json
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
{
"documentationUrl": "https://docs.airbyte.com/integrations/sources/zendesk-support",
"connectionSpecification": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Source Zendesk Support Spec",
"type": "object",
"required": ["start_date", "subdomain"],
"additionalProperties": true,
"properties": {
"start_date": {
"type": "string",
"title": "Start Date",
"description": "The date from which you'd like to replicate data for Zendesk Support API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.",
"examples": ["2020-10-15T00:00:00Z"],
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$",
"format": "date-time"
},
"subdomain": {
"type": "string",
"title": "Subdomain",
"description": "This is your Zendesk subdomain that can be found in your account URL. For example, in https://{MY_SUBDOMAIN}.zendesk.com/, where MY_SUBDOMAIN is the value of your subdomain."
},
"credentials": {
"title": "Authentication",
"type": "object",
"description": "Zendesk service provides two authentication methods. Choose between: `OAuth2.0` or `API token`.",
"oneOf": [
{
"title": "OAuth2.0",
"type": "object",
"required": ["access_token"],
"additionalProperties": true,
"properties": {
"credentials": {
"type": "string",
"const": "oauth2.0",
"order": 0
},
"access_token": {
"type": "string",
"title": "Access Token",
"description": "The value of the API token generated. See the <a href=\"https://docs.airbyte.com/integrations/sources/zendesk-support\">docs</a> for more information.",
"airbyte_secret": true
}
}
},
{
"title": "API Token",
"type": "object",
"required": ["email", "api_token"],
"additionalProperties": true,
"properties": {
"credentials": {
"type": "string",
"const": "api_token",
"order": 0
},
"email": {
"title": "Email",
"type": "string",
"description": "The user email for your Zendesk account."
},
"api_token": {
"title": "API Token",
"type": "string",
"description": "The value of the API token generated. See the <a href=\"https://docs.airbyte.com/integrations/sources/zendesk-support#setup-guide\">docs</a> for more information.",
"airbyte_secret": true
}
}
}
]
},
"ignore_pagination": {
"type": "boolean",
"default": false,
"description": "Makes each stream read a single page of data.",
"title": "Should the connector read the second and further pages of data.",
"airbyte_hidden": true
}
}
},
"advanced_auth": {
"auth_flow_type": "oauth2.0",
"predicate_key": ["credentials", "credentials"],
"predicate_value": "oauth2.0",
"oauth_config_specification": {
"complete_oauth_output_specification": {
"type": "object",
"additionalProperties": false,
"properties": {
"access_token": {
"type": "string",
"path_in_connector_config": ["credentials", "access_token"]
}
}
},
"complete_oauth_server_input_specification": {
"type": "object",
"additionalProperties": false,
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
}
}
},
"oauth_user_input_from_connector_config_specification": {
"type": "object",
"additionalProperties": false,
"properties": {
"subdomain": {
"type": "string",
"path_in_connector_config": ["subdomain"]
}
}
}
}
}
}