forked from apache/airflow
/
provider.yaml.schema.json
221 lines (221 loc) · 6.27 KB
/
provider.yaml.schema.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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"package-name": {
"description": "Package name available under which the package is available in the PyPI repository.",
"type": "string"
},
"name": {
"description": "Provider name",
"type": "string"
},
"description": {
"description": "Information about the package in RST format",
"type": "string"
},
"versions": {
"description": "List of available versions in PyPI. Sorted descending according to release date.",
"type": "array",
"items": {
"type": "string"
}
},
"additional-dependencies": {
"description": "Additional dependencies that should be added to the provider",
"type": "array",
"items": {
"type": "string"
}
},
"excluded-python-versions": {
"description": "List of python versions excluded for that provider",
"type": "array",
"items": {
"type": "string"
}
},
"integrations": {
"description": "List of integrations supported by the provider.",
"type": "array",
"items": {
"type": "object",
"properties": {
"integration-name": {
"type": "string",
"description": "Name of the integration."
},
"external-doc-url": {
"type": "string",
"description": "URL to external documentation for the integration."
},
"how-to-guide": {
"description": "List of paths to how-to-guide for the integration. The path must start with '/docs/'",
"type": "array",
"items": {
"type": "string"
}
},
"logo": {
"description": "Path to the logo for the integration. The path must start with '/integration-logos/'",
"type": "string"
},
"tags": {
"description": "List of tags describing the integration. While we're using RST, only one tag is supported per integration.",
"type": "array",
"items": {
"type": "string",
"enum": [
"apache",
"aws",
"azure",
"gcp",
"gmp",
"google",
"protocol",
"service",
"software",
"yandex"
]
},
"minItems": 1,
"maxItems": 1
}
},
"additionalProperties": false,
"required": [
"integration-name",
"external-doc-url",
"tags"
]
}
},
"operators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"integration-name": {
"type": "string",
"description": "Integration name. It must have a matching item in the 'integration' section of any provider."
},
"python-modules": {
"description": "List of python modules containing the operators.",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"integration-name",
"python-modules"
]
}
},
"sensors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"integration-name": {
"type": "string",
"description": "Integration name. It must have a matching item in the 'integration' section of any provider."
},
"python-modules": {
"description": "List of python modules containing the sensors.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"integration-name",
"python-modules"
],
"additionalProperties": true
}
},
"hooks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"integration-name": {
"type": "string",
"description": "Integration name. It must have a matching item in the 'integration' section of any provider."
},
"python-modules": {
"description": "List of python modules containing the hooks.",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"integration-name",
"python-modules"
]
}
},
"transfers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"how-to-guide": {
"description": "Path to how-to-guide for the transfer. The path must start with '/docs/'",
"type": "string"
},
"source-integration-name": {
"type": "string",
"description": "Integration name. It must have a matching item in the 'integration' section of any provider."
},
"target-integration-name": {
"type": "string",
"description": "Target integration name. It must have a matching item in the 'integration' section of any provider."
},
"python-module": {
"type": "string",
"description": "List of python modules containing the transfers."
}
},
"additionalProperties": false,
"required": [
"source-integration-name",
"target-integration-name",
"python-module"
]
}
},
"hook-class-names": {
"type": "array",
"description": "Hook class names that provide connection types to core",
"items": {
"type": "string"
}
},
"extra-links": {
"type": "array",
"description": "Operator class names that provide extra link functionality",
"items": {
"type": "string"
}
},
"additional-extras": {
"type": "object",
"description": "Additional extras that the provider should have"
}
},
"additionalProperties": false,
"required": [
"name",
"package-name",
"description",
"versions"
]
}