Skip to content

Commit e2ba2ed

Browse files
authored
Swagger changes for Synapse flowlets (#16335)
* Swagger changes for Synapse flowlets * Add Flowlet to custom words * Address comments
1 parent c930a0d commit e2ba2ed

File tree

6 files changed

+282
-0
lines changed

6 files changed

+282
-0
lines changed

specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2945,6 +2945,13 @@
29452945
"description": "Data flow instance.",
29462946
"$ref": "#/definitions/DataFlowResource"
29472947
},
2948+
"dataFlows": {
2949+
"description": "List of Data flows",
2950+
"type": "array",
2951+
"items": {
2952+
"$ref": "#/definitions/DataFlowResource"
2953+
}
2954+
},
29482955
"datasets": {
29492956
"type": "array",
29502957
"description": "List of datasets.",
@@ -3868,6 +3875,13 @@
38683875
"description": "Data flow instance.",
38693876
"$ref": "#/definitions/DataFlowDebugResource"
38703877
},
3878+
"dataFlows": {
3879+
"description": "List of Data flows",
3880+
"type": "array",
3881+
"items": {
3882+
"$ref": "#/definitions/DataFlowDebugResource"
3883+
}
3884+
},
38713885
"datasets": {
38723886
"type": "array",
38733887
"description": "List of datasets.",

specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/DataFlow.json

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,26 @@
5858
}
5959
}
6060
},
61+
"Flowlet": {
62+
"x-ms-discriminator-value": "Flowlet",
63+
"description": "Data flow flowlet",
64+
"type": "object",
65+
"allOf": [
66+
{
67+
"$ref": "#/definitions/DataFlow"
68+
}
69+
],
70+
"properties": {
71+
"typeProperties": {
72+
"description": "Flowlet type properties.",
73+
"x-ms-client-flatten": true,
74+
"$ref": "#/definitions/FlowletTypeProperties"
75+
}
76+
},
77+
"additionalProperties": {
78+
"type": "object"
79+
}
80+
},
6181
"MappingDataFlowTypeProperties": {
6282
"description": "Mapping data flow type properties.",
6383
"type": "object",
@@ -86,6 +106,13 @@
86106
"script": {
87107
"type": "string",
88108
"description": "DataFlow script."
109+
},
110+
"scriptLines": {
111+
"type": "array",
112+
"description": "Data flow script lines.",
113+
"items": {
114+
"type": "string"
115+
}
89116
}
90117
}
91118
},
@@ -100,6 +127,10 @@
100127
"description": {
101128
"description": "Transformation description.",
102129
"type": "string"
130+
},
131+
"flowlet": {
132+
"description": "Flowlet Reference",
133+
"$ref": "../artifacts.json#/definitions/DataFlowReference"
103134
}
104135
},
105136
"required": [
@@ -126,6 +157,10 @@
126157
"schemaLinkedService": {
127158
"description": "Schema linked service reference.",
128159
"$ref": "../artifacts.json#/definitions/LinkedServiceReference"
160+
},
161+
"flowlet": {
162+
"description": "Flowlet Reference",
163+
"$ref": "../artifacts.json#/definitions/DataFlowReference"
129164
}
130165
}
131166
},
@@ -149,6 +184,51 @@
149184
"schemaLinkedService": {
150185
"description": "Schema linked service reference.",
151186
"$ref": "../artifacts.json#/definitions/LinkedServiceReference"
187+
},
188+
"flowlet": {
189+
"description": "Flowlet Reference",
190+
"$ref": "../artifacts.json#/definitions/DataFlowReference"
191+
}
192+
}
193+
},
194+
"FlowletTypeProperties": {
195+
"description": "Flowlet type properties.",
196+
"type": "object",
197+
"properties": {
198+
"sources": {
199+
"type": "array",
200+
"description": "List of sources in Flowlet.",
201+
"items": {
202+
"$ref": "#/definitions/DataFlowSource"
203+
}
204+
},
205+
"sinks": {
206+
"type": "array",
207+
"description": "List of sinks in Flowlet.",
208+
"items": {
209+
"$ref": "#/definitions/DataFlowSink"
210+
}
211+
},
212+
"transformations": {
213+
"type": "array",
214+
"description": "List of transformations in Flowlet.",
215+
"items": {
216+
"$ref": "#/definitions/Transformation"
217+
}
218+
},
219+
"script": {
220+
"type": "string",
221+
"description": "Flowlet script."
222+
},
223+
"scriptLines": {
224+
"type": "array",
225+
"description": "Flowlet script lines.",
226+
"items": {
227+
"type": "string"
228+
}
229+
},
230+
"additionalProperties": {
231+
"type": "object"
152232
}
153233
}
154234
}

specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/dataflows.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -630,6 +630,13 @@
630630
"description": "Data flow instance.",
631631
"$ref": "#/definitions/DataFlowDebugResource"
632632
},
633+
"dataFlows": {
634+
"description": "List of Data flows",
635+
"type": "array",
636+
"items": {
637+
"$ref": "#/definitions/DataFlowDebugResource"
638+
}
639+
},
633640
"datasets": {
634641
"type": "array",
635642
"description": "List of datasets.",
@@ -745,6 +752,13 @@
745752
"description": "Data flow instance.",
746753
"$ref": "dataflows.json#/definitions/DataFlowResource"
747754
},
755+
"dataFlows": {
756+
"description": "List of Data flows",
757+
"type": "array",
758+
"items": {
759+
"$ref": "#/definitions/DataFlowResource"
760+
}
761+
},
748762
"datasets": {
749763
"type": "array",
750764
"description": "List of datasets.",

specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/DataFlow.json

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,26 @@
5858
}
5959
}
6060
},
61+
"Flowlet": {
62+
"x-ms-discriminator-value": "Flowlet",
63+
"description": "Data flow flowlet",
64+
"type": "object",
65+
"allOf": [
66+
{
67+
"$ref": "#/definitions/DataFlow"
68+
}
69+
],
70+
"properties": {
71+
"typeProperties": {
72+
"description": "Flowlet type properties.",
73+
"x-ms-client-flatten": true,
74+
"$ref": "#/definitions/FlowletTypeProperties"
75+
}
76+
},
77+
"additionalProperties": {
78+
"type": "object"
79+
}
80+
},
6181
"MappingDataFlowTypeProperties": {
6282
"description": "Mapping data flow type properties.",
6383
"type": "object",
@@ -86,6 +106,13 @@
86106
"script": {
87107
"type": "string",
88108
"description": "DataFlow script."
109+
},
110+
"scriptLines": {
111+
"type": "array",
112+
"description": "Data flow script lines.",
113+
"items": {
114+
"type": "string"
115+
}
89116
}
90117
}
91118
},
@@ -100,6 +127,10 @@
100127
"description": {
101128
"description": "Transformation description.",
102129
"type": "string"
130+
},
131+
"flowlet": {
132+
"description": "Flowlet Reference",
133+
"$ref": "../artifacts.json#/definitions/DataFlowReference"
103134
}
104135
},
105136
"required": [
@@ -126,6 +157,10 @@
126157
"schemaLinkedService": {
127158
"description": "Schema linked service reference.",
128159
"$ref": "../artifacts.json#/definitions/LinkedServiceReference"
160+
},
161+
"flowlet": {
162+
"description": "Flowlet Reference",
163+
"$ref": "../artifacts.json#/definitions/DataFlowReference"
129164
}
130165
}
131166
},
@@ -149,6 +184,51 @@
149184
"schemaLinkedService": {
150185
"description": "Schema linked service reference.",
151186
"$ref": "../artifacts.json#/definitions/LinkedServiceReference"
187+
},
188+
"flowlet": {
189+
"description": "Flowlet Reference",
190+
"$ref": "../artifacts.json#/definitions/DataFlowReference"
191+
}
192+
}
193+
},
194+
"FlowletTypeProperties": {
195+
"description": "Flowlet type properties.",
196+
"type": "object",
197+
"properties": {
198+
"sources": {
199+
"type": "array",
200+
"description": "List of sources in Flowlet.",
201+
"items": {
202+
"$ref": "#/definitions/DataFlowSource"
203+
}
204+
},
205+
"sinks": {
206+
"type": "array",
207+
"description": "List of sinks in Flowlet.",
208+
"items": {
209+
"$ref": "#/definitions/DataFlowSink"
210+
}
211+
},
212+
"transformations": {
213+
"type": "array",
214+
"description": "List of transformations in Flowlet.",
215+
"items": {
216+
"$ref": "#/definitions/Transformation"
217+
}
218+
},
219+
"script": {
220+
"type": "string",
221+
"description": "Flowlet script."
222+
},
223+
"scriptLines": {
224+
"type": "array",
225+
"description": "Flowlet script lines.",
226+
"items": {
227+
"type": "string"
228+
}
229+
},
230+
"additionalProperties": {
231+
"type": "object"
152232
}
153233
}
154234
}

specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/dataflows.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -630,6 +630,13 @@
630630
"description": "Data flow instance.",
631631
"$ref": "#/definitions/DataFlowDebugResource"
632632
},
633+
"dataFlows": {
634+
"description": "List of Data flows",
635+
"type": "array",
636+
"items": {
637+
"$ref": "#/definitions/DataFlowDebugResource"
638+
}
639+
},
633640
"datasets": {
634641
"type": "array",
635642
"description": "List of datasets.",
@@ -745,6 +752,13 @@
745752
"description": "Data flow instance.",
746753
"$ref": "dataflows.json#/definitions/DataFlowResource"
747754
},
755+
"dataFlows": {
756+
"description": "List of Data flows",
757+
"type": "array",
758+
"items": {
759+
"$ref": "#/definitions/DataFlowResource"
760+
}
761+
},
748762
"datasets": {
749763
"type": "array",
750764
"description": "List of datasets.",

0 commit comments

Comments
 (0)