Skip to content

Commit 6ae0fb5

Browse files
wangbwnBoWangzi1
wangbwn
and
BoWangzi1
authored
fix swagger definition. (#26846)
* fix swagger definition. * fix header and dataPathAssignments definition. * Update synapse swagger definition. * Fix swagger definition. * Update synapse swagger definition. * Revert "Update synapse swagger definition." This reverts commit 274c127. * Revert "Update synapse swagger definition." This reverts commit c6082ef. * fix header definition. * fix swagger definition. * fix snowflake linked service definition. * fix dataset schema. --------- Co-authored-by: Bo Wang <v-bw@microsoft.com>
1 parent 1ca8b90 commit 6ae0fb5

File tree

4 files changed

+57
-41
lines changed

4 files changed

+57
-41
lines changed

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
},
3939
"schema": {
4040
"type": "object",
41-
"x-ms-format": "dfe-list-generic",
41+
"x-ms-format": "dfe-object",
4242
"x-ms-format-element-type": "DatasetSchemaDataElement",
4343
"description": "Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement."
4444
},

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -478,12 +478,14 @@
478478
"type": "object",
479479
"properties": {
480480
"targetName": {
481-
"description": "The server name of data source access.",
482-
"type": "object"
481+
"description": "The server name of data source access. Type: string.",
482+
"type": "object",
483+
"x-ms-format": "dfe-string"
483484
},
484485
"userName": {
485-
"description": "The user name of data source access.",
486-
"type": "object"
486+
"description": "The user name of data source access. Type: string.",
487+
"type": "object",
488+
"x-ms-format": "dfe-string"
487489
},
488490
"password": {
489491
"description": "The password of data source access.",

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2203,8 +2203,8 @@
22032203
},
22042204
"authHeaders": {
22052205
"type": "object",
2206-
"x-ms-format": "dfe-object",
2207-
"description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object)."
2206+
"x-ms-format": "dfe-key-value-pairs",
2207+
"description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type)."
22082208
},
22092209
"tenant": {
22102210
"type": "object",
@@ -4003,8 +4003,8 @@
40034003
},
40044004
"authHeaders": {
40054005
"type": "object",
4006-
"x-ms-format": "dfe-object",
4007-
"description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object)."
4006+
"x-ms-format": "dfe-key-value-pairs",
4007+
"description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type)."
40084008
},
40094009
"embeddedCertData": {
40104010
"type": "object",
@@ -6369,8 +6369,8 @@
63696369
"properties": {
63706370
"clusterSize": {
63716371
"type": "object",
6372-
"x-ms-format": "dfe-string",
6373-
"description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string)."
6372+
"x-ms-format": "dfe-int",
6373+
"description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int)."
63746374
},
63756375
"timeToLive": {
63766376
"type": "object",
@@ -7322,8 +7322,9 @@
73227322
"type": "object",
73237323
"properties": {
73247324
"functionAppUrl": {
7325-
"description": "The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net.",
7326-
"type": "object"
7325+
"description": "The endpoint of the Azure Function App. URL will be in the format https://<accountName>.azurewebsites.net. Type: string (or Expression with resultType string).",
7326+
"type": "object",
7327+
"x-ms-format": "dfe-string"
73277328
},
73287329
"functionKey": {
73297330
"description": "Function or Host key for Azure Function App.",
@@ -7338,8 +7339,9 @@
73387339
"description": "The credential reference containing authentication information."
73397340
},
73407341
"resourceId": {
7341-
"description": "Allowed token audiences for azure function.",
7342-
"type": "object"
7342+
"description": "Allowed token audiences for azure function. Type: string (or Expression with resultType string).",
7343+
"type": "object",
7344+
"x-ms-format": "dfe-string"
73437345
},
73447346
"authentication": {
73457347
"type": "object",
@@ -7377,7 +7379,8 @@
73777379
"properties": {
73787380
"connectionString": {
73797381
"description": "The connection string of snowflake. Type: string, SecureString.",
7380-
"type": "object"
7382+
"type": "object",
7383+
"x-ms-format": "dfe-string"
73817384
},
73827385
"password": {
73837386
"$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json‎

Lines changed: 36 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2640,8 +2640,8 @@
26402640
},
26412641
"additionalHeaders": {
26422642
"type": "object",
2643-
"x-ms-format": "dfe-string",
2644-
"description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)."
2643+
"x-ms-format": "dfe-key-value-pairs",
2644+
"description": "The additional HTTP headers in the request to the RESTful API. Type: key value pairs (value should be string type)."
26452645
},
26462646
"httpRequestTimeout": {
26472647
"type": "object",
@@ -2654,7 +2654,8 @@
26542654
},
26552655
"httpCompressionType": {
26562656
"type": "object",
2657-
"description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. "
2657+
"x-ms-format": "dfe-string",
2658+
"description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. Type: string (or Expression with resultType string)."
26582659
}
26592660
}
26602661
},
@@ -2698,7 +2699,8 @@
26982699
},
26992700
"additionalColumns": {
27002701
"type": "object",
2701-
"description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)."
2702+
"x-ms-format": "dfe-key-value-pairs",
2703+
"description": "Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type)."
27022704
}
27032705
}
27042706
},
@@ -2731,8 +2733,9 @@
27312733
"type": "object"
27322734
},
27332735
"partitionOption": {
2734-
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".",
2735-
"type": "object"
2736+
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).",
2737+
"type": "object",
2738+
"x-ms-format": "dfe-string"
27362739
},
27372740
"partitionSettings": {
27382741
"description": "The settings that will be leveraged for Sql source partitioning.",
@@ -2773,8 +2776,9 @@
27732776
"type": "object"
27742777
},
27752778
"partitionOption": {
2776-
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".",
2777-
"type": "object"
2779+
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).",
2780+
"type": "object",
2781+
"x-ms-format": "dfe-string"
27782782
},
27792783
"partitionSettings": {
27802784
"description": "The settings that will be leveraged for Sql source partitioning.",
@@ -2857,8 +2861,9 @@
28572861
"type": "object"
28582862
},
28592863
"partitionOption": {
2860-
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".",
2861-
"type": "object"
2864+
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).",
2865+
"type": "object",
2866+
"x-ms-format": "dfe-string"
28622867
},
28632868
"partitionSettings": {
28642869
"description": "The settings that will be leveraged for Sql source partitioning.",
@@ -2899,8 +2904,9 @@
28992904
"type": "object"
29002905
},
29012906
"partitionOption": {
2902-
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".",
2903-
"type": "object"
2907+
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).",
2908+
"type": "object",
2909+
"x-ms-format": "dfe-string"
29042910
},
29052911
"partitionSettings": {
29062912
"description": "The settings that will be leveraged for Sql source partitioning.",
@@ -2937,8 +2943,9 @@
29372943
"type": "object"
29382944
},
29392945
"partitionOption": {
2940-
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".",
2941-
"type": "object"
2946+
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).",
2947+
"type": "object",
2948+
"x-ms-format": "dfe-string"
29422949
},
29432950
"partitionSettings": {
29442951
"description": "The settings that will be leveraged for Sql source partitioning.",
@@ -4754,7 +4761,8 @@
47544761
},
47554762
"writeBehavior": {
47564763
"type": "object",
4757-
"description": "Write behavior when copying data into sql. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)"
4764+
"x-ms-format": "dfe-string",
4765+
"description": "Write behavior when copying data into sql. Type: string (or Expression with resultType string)."
47584766
},
47594767
"upsertSettings": {
47604768
"description": "SQL upsert settings.",
@@ -4808,7 +4816,8 @@
48084816
},
48094817
"writeBehavior": {
48104818
"type": "object",
4811-
"description": "Write behavior when copying data into sql server. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)"
4819+
"x-ms-format": "dfe-string",
4820+
"description": "Write behavior when copying data into sql server. Type: string (or Expression with resultType string)."
48124821
},
48134822
"upsertSettings": {
48144823
"description": "SQL upsert settings.",
@@ -4916,7 +4925,8 @@
49164925
},
49174926
"writeBehavior": {
49184927
"type": "object",
4919-
"description": "White behavior when copying data into azure SQL MI. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)"
4928+
"x-ms-format": "dfe-string",
4929+
"description": "White behavior when copying data into azure SQL MI. Type: string (or Expression with resultType string)"
49204930
},
49214931
"upsertSettings": {
49224932
"description": "SQL upsert settings.",
@@ -5966,6 +5976,7 @@
59665976
},
59675977
"arguments": {
59685978
"type": "object",
5979+
"x-ms-format": "dfe-list-string",
59695980
"description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)."
59705981
},
59715982
"getDebugInfo": {
@@ -6996,8 +7007,8 @@
69967007
},
69977008
"headers": {
69987009
"type": "object",
6999-
"x-ms-format": "dfe-string",
7000-
"description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)."
7010+
"x-ms-format": "dfe-key-value-pairs",
7011+
"description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: dictionary (or Expression with resultType dictionary)."
70017012
},
70027013
"body": {
70037014
"type": "object",
@@ -7430,8 +7441,7 @@
74307441
"type": "object"
74317442
},
74327443
"dataPathAssignments": {
7433-
"x-ms-format": "dfe-key-value-pairs",
7434-
"description": "Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).",
7444+
"description": "Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object (or Expression with resultType object).",
74357445
"type": "object"
74367446
},
74377447
"mlParentRunId": {
@@ -8035,8 +8045,8 @@
80358045
},
80368046
"headers": {
80378047
"type": "object",
8038-
"x-ms-format": "dfe-string",
8039-
"description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)."
8048+
"x-ms-format": "dfe-key-value-pairs",
8049+
"description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: dictionary (or Expression with resultType dictionary)."
80408050
},
80418051
"body": {
80428052
"type": "object",
@@ -8101,8 +8111,8 @@
81018111
},
81028112
"headers": {
81038113
"type": "object",
8104-
"x-ms-format": "dfe-string",
8105-
"description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)."
8114+
"x-ms-format": "dfe-key-value-pairs",
8115+
"description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: dictionary (or Expression with resultType dictionary)."
81068116
},
81078117
"body": {
81088118
"type": "object",
@@ -8871,6 +8881,7 @@
88718881
},
88728882
"referenceName": {
88738883
"type": "object",
8884+
"x-ms-format": "dfe-string",
88748885
"description": "Reference spark job name. Expression with resultType string."
88758886
}
88768887
},

0 commit comments

Comments
 (0)