From 515862d69cf76040c293c8f3c1eef593610c31b3 Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Mon, 27 Nov 2023 16:29:05 +0800 Subject: [PATCH 01/11] fix swagger definition. --- .../2018-06-01/entityTypes/Dataset.json | 8 ++++ .../entityTypes/IntegrationRuntime.json | 10 +++-- .../2018-06-01/entityTypes/LinkedService.json | 18 ++++---- .../2018-06-01/entityTypes/Pipeline.json | 45 ++++++++++++------- 4 files changed, 52 insertions(+), 29 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index e8091e577224..34bde7b55085 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -605,6 +605,10 @@ "description": "Avro dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/AvroDatasetTypeProperties" + }, + "schema": { + "type": "object", + "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, @@ -844,6 +848,10 @@ "description": "Json dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/JsonDatasetTypeProperties" + }, + "schema": { + "type": "object", + "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json index 0e5dc7dc7cf6..60fea2a94ab0 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json @@ -478,12 +478,14 @@ "type": "object", "properties": { "targetName": { - "description": "The server name of data source access.", - "type": "object" + "description": "The server name of data source access. Type: string.", + "type": "object", + "x-ms-format": "dfe-string" }, "userName": { - "description": "The user name of data source access.", - "type": "object" + "description": "The user name of data source access. Type: string.", + "type": "object", + "x-ms-format": "dfe-string" }, "password": { "description": "The password of data source access.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 50c721b67e69..044c5b052c4d 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -2203,8 +2203,8 @@ }, "authHeaders": { "type": "object", - "x-ms-format": "dfe-object", - "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object)." + "x-ms-format": "dfe-key-value-pairs", + "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type)." }, "tenant": { "type": "object", @@ -4003,8 +4003,8 @@ }, "authHeaders": { "type": "object", - "x-ms-format": "dfe-object", - "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object)." + "x-ms-format": "dfe-key-value-pairs", + "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type)." }, "embeddedCertData": { "type": "object", @@ -7322,8 +7322,9 @@ "type": "object", "properties": { "functionAppUrl": { - "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net.", - "type": "object" + "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net. Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "functionKey": { "description": "Function or Host key for Azure Function App.", @@ -7338,8 +7339,9 @@ "description": "The credential reference containing authentication information." }, "resourceId": { - "description": "Allowed token audiences for azure function.", - "type": "object" + "description": "Allowed token audiences for azure function. Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "authentication": { "type": "object", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 5376918c0ea5..c0cd9a5c040a 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -2640,8 +2640,8 @@ }, "additionalHeaders": { "type": "object", - "x-ms-format": "dfe-string", - "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-key-value-pairs", + "description": "The additional HTTP headers in the request to the RESTful API. Type: key value pairs (value should be string type)." }, "httpRequestTimeout": { "type": "object", @@ -2654,7 +2654,8 @@ }, "httpCompressionType": { "type": "object", - "description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. " + "x-ms-format": "dfe-string", + "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)." } } }, @@ -2698,7 +2699,8 @@ }, "additionalColumns": { "type": "object", - "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." + "x-ms-format": "dfe-key-value-pairs", + "description": "Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type)." } } }, @@ -2731,8 +2733,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "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).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2773,8 +2776,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "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).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2857,8 +2861,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "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).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2899,8 +2904,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "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).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2937,8 +2943,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "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).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -4754,7 +4761,8 @@ }, "writeBehavior": { "type": "object", - "description": "Write behavior when copying data into sql. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + "x-ms-format": "dfe-string", + "description": "Write behavior when copying data into sql. Type: string (or Expression with resultType string)." }, "upsertSettings": { "description": "SQL upsert settings.", @@ -4808,7 +4816,8 @@ }, "writeBehavior": { "type": "object", - "description": "Write behavior when copying data into sql server. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + "x-ms-format": "dfe-string", + "description": "Write behavior when copying data into sql server. Type: string (or Expression with resultType string)." }, "upsertSettings": { "description": "SQL upsert settings.", @@ -4916,7 +4925,8 @@ }, "writeBehavior": { "type": "object", - "description": "White behavior when copying data into azure SQL MI. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + "x-ms-format": "dfe-string", + "description": "White behavior when copying data into azure SQL MI. Type: string (or Expression with resultType string)" }, "upsertSettings": { "description": "SQL upsert settings.", @@ -8862,6 +8872,7 @@ }, "referenceName": { "type": "object", + "x-ms-format": "dfe-string", "description": "Reference spark job name. Expression with resultType string." } }, From b9c58ac97e5635eb10a2225be08ee7dd5282c760 Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Tue, 28 Nov 2023 11:27:23 +0800 Subject: [PATCH 02/11] fix header and dataPathAssignments definition. --- .../stable/2018-06-01/entityTypes/Pipeline.json | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index c0cd9a5c040a..4386b12324c5 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -7006,8 +7006,7 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-string", - "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)." + "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)." }, "body": { "type": "object", @@ -7431,8 +7430,7 @@ "type": "object" }, "dataPathAssignments": { - "x-ms-format": "dfe-key-value-pairs", - "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).", + "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).", "type": "object" }, "mlParentRunId": { @@ -8036,8 +8034,7 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-string", - "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)." + "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)." }, "body": { "type": "object", @@ -8102,8 +8099,7 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-string", - "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)." + "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)." }, "body": { "type": "object", From c6082ef237cf39eb8a4145554d27e5741e6e454a Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Tue, 28 Nov 2023 15:02:21 +0800 Subject: [PATCH 03/11] Update synapse swagger definition. --- .../2020-12-01/entityTypes/Dataset.json | 8 ++++ .../2020-12-01/entityTypes/LinkedService.json | 10 +++-- .../2020-12-01/entityTypes/Pipeline.json | 40 +++++++++++-------- 3 files changed, 38 insertions(+), 20 deletions(-) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json index 3a69786afcf8..47bca5e54132 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json @@ -516,6 +516,10 @@ "description": "Avro dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/AvroDatasetTypeProperties" + }, + "schema": { + "type": "object", + "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, @@ -756,6 +760,10 @@ "description": "Json dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/JsonDatasetTypeProperties" + }, + "schema": { + "type": "object", + "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index 713b4e989598..2169fd987e6d 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -6718,8 +6718,9 @@ "type": "object", "properties": { "functionAppUrl": { - "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net.", - "type": "object" + "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net. Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "functionKey": { "description": "Function or Host key for Azure Function App.", @@ -6734,8 +6735,9 @@ "description": "The credential reference containing authentication information." }, "resourceId": { - "description": "Allowed token audiences for azure function.", - "type": "object" + "description": "Allowed token audiences for azure function. Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "authentication": { "type": "object", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json index ea798dcd31c5..00dd7faf6b9b 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -2257,7 +2257,8 @@ }, "additionalHeaders": { "type": "object", - "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-key-value-pairs", + "description": "The additional HTTP headers in the request to the RESTful API. Type: key value pairs (value should be string type)." }, "httpRequestTimeout": { "type": "object", @@ -2269,7 +2270,8 @@ }, "httpCompressionType": { "type": "object", - "description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. " + "x-ms-format": "dfe-string", + "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)." } } }, @@ -2308,7 +2310,8 @@ }, "additionalColumns": { "type": "object", - "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." + "x-ms-format": "dfe-key-value-pairs", + "description": "Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type)." } } }, @@ -2338,8 +2341,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "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).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2377,8 +2381,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "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).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2455,8 +2460,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "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).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2494,8 +2500,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "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).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2529,8 +2536,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "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).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -6173,7 +6181,7 @@ }, "headers": { "type": "object", - "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)." + "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)." }, "body": { "type": "object", @@ -7146,7 +7154,7 @@ }, "headers": { "type": "object", - "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)." + "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)." }, "body": { "type": "object", @@ -7207,7 +7215,7 @@ }, "headers": { "type": "object", - "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)." + "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)." }, "body": { "type": "object", From b1d161e6e8c485ad67a253b7e5e61b28bc3f6092 Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Tue, 28 Nov 2023 17:23:35 +0800 Subject: [PATCH 04/11] Fix swagger definition. --- .../stable/2018-06-01/entityTypes/LinkedService.json | 4 ++-- .../stable/2018-06-01/entityTypes/Pipeline.json | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 044c5b052c4d..6b3206c31265 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -6369,8 +6369,8 @@ "properties": { "clusterSize": { "type": "object", - "x-ms-format": "dfe-string", - "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-int", + "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int)." }, "timeToLive": { "type": "object", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 4386b12324c5..cee38dda953a 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -5976,6 +5976,7 @@ }, "arguments": { "type": "object", + "x-ms-format": "dfe-list-string", "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." }, "getDebugInfo": { From 274c127cb3e7ca01986cb945a0bd75b7f7601397 Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Tue, 28 Nov 2023 17:35:52 +0800 Subject: [PATCH 05/11] Update synapse swagger definition. --- .../stable/2020-12-01/entityTypes/LinkedService.json | 3 ++- .../stable/2020-12-01/entityTypes/Pipeline.json | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index 2169fd987e6d..dc0844b80450 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -5857,7 +5857,8 @@ "properties": { "clusterSize": { "type": "object", - "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-int", + "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int)." }, "timeToLive": { "type": "object", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json index 00dd7faf6b9b..0098159604e4 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -5215,6 +5215,7 @@ }, "arguments": { "type": "object", + "x-ms-format": "dfe-list-string", "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." }, "getDebugInfo": { From f2d1453ecc28a6c6374c43f4b33ce6a5f1086401 Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Wed, 29 Nov 2023 10:52:09 +0800 Subject: [PATCH 06/11] Revert "Update synapse swagger definition." This reverts commit 274c127cb3e7ca01986cb945a0bd75b7f7601397. --- .../stable/2020-12-01/entityTypes/LinkedService.json | 3 +-- .../stable/2020-12-01/entityTypes/Pipeline.json | 1 - 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index dc0844b80450..2169fd987e6d 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -5857,8 +5857,7 @@ "properties": { "clusterSize": { "type": "object", - "x-ms-format": "dfe-int", - "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int)." + "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string)." }, "timeToLive": { "type": "object", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json index 0098159604e4..00dd7faf6b9b 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -5215,7 +5215,6 @@ }, "arguments": { "type": "object", - "x-ms-format": "dfe-list-string", "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." }, "getDebugInfo": { From e6283c7c2c8617225705ebe7cfee4255965fbb0f Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Wed, 29 Nov 2023 10:53:05 +0800 Subject: [PATCH 07/11] Revert "Update synapse swagger definition." This reverts commit c6082ef237cf39eb8a4145554d27e5741e6e454a. --- .../2020-12-01/entityTypes/Dataset.json | 8 ---- .../2020-12-01/entityTypes/LinkedService.json | 10 ++--- .../2020-12-01/entityTypes/Pipeline.json | 40 ++++++++----------- 3 files changed, 20 insertions(+), 38 deletions(-) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json index 47bca5e54132..3a69786afcf8 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json @@ -516,10 +516,6 @@ "description": "Avro dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/AvroDatasetTypeProperties" - }, - "schema": { - "type": "object", - "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, @@ -760,10 +756,6 @@ "description": "Json dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/JsonDatasetTypeProperties" - }, - "schema": { - "type": "object", - "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index 2169fd987e6d..713b4e989598 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -6718,9 +6718,8 @@ "type": "object", "properties": { "functionAppUrl": { - "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net. Type: string (or Expression with resultType string).", - "type": "object", - "x-ms-format": "dfe-string" + "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net.", + "type": "object" }, "functionKey": { "description": "Function or Host key for Azure Function App.", @@ -6735,9 +6734,8 @@ "description": "The credential reference containing authentication information." }, "resourceId": { - "description": "Allowed token audiences for azure function. Type: string (or Expression with resultType string).", - "type": "object", - "x-ms-format": "dfe-string" + "description": "Allowed token audiences for azure function.", + "type": "object" }, "authentication": { "type": "object", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json index 00dd7faf6b9b..ea798dcd31c5 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -2257,8 +2257,7 @@ }, "additionalHeaders": { "type": "object", - "x-ms-format": "dfe-key-value-pairs", - "description": "The additional HTTP headers in the request to the RESTful API. Type: key value pairs (value should be string type)." + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." }, "httpRequestTimeout": { "type": "object", @@ -2270,8 +2269,7 @@ }, "httpCompressionType": { "type": "object", - "x-ms-format": "dfe-string", - "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)." + "description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. " } } }, @@ -2310,8 +2308,7 @@ }, "additionalColumns": { "type": "object", - "x-ms-format": "dfe-key-value-pairs", - "description": "Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type)." + "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." } } }, @@ -2341,9 +2338,8 @@ "type": "object" }, "partitionOption": { - "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).", - "type": "object", - "x-ms-format": "dfe-string" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2381,9 +2377,8 @@ "type": "object" }, "partitionOption": { - "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).", - "type": "object", - "x-ms-format": "dfe-string" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2460,9 +2455,8 @@ "type": "object" }, "partitionOption": { - "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).", - "type": "object", - "x-ms-format": "dfe-string" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2500,9 +2494,8 @@ "type": "object" }, "partitionOption": { - "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).", - "type": "object", - "x-ms-format": "dfe-string" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2536,9 +2529,8 @@ "type": "object" }, "partitionOption": { - "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).", - "type": "object", - "x-ms-format": "dfe-string" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", + "type": "object" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -6181,7 +6173,7 @@ }, "headers": { "type": "object", - "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)." + "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)." }, "body": { "type": "object", @@ -7154,7 +7146,7 @@ }, "headers": { "type": "object", - "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)." + "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)." }, "body": { "type": "object", @@ -7215,7 +7207,7 @@ }, "headers": { "type": "object", - "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)." + "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)." }, "body": { "type": "object", From f0c552cb16fb4d4ccbe662e8d596ff1414f6f9eb Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Wed, 29 Nov 2023 13:11:17 +0800 Subject: [PATCH 08/11] fix header definition. --- .../stable/2018-06-01/entityTypes/Pipeline.json | 3 +++ .../stable/2020-12-01/entityTypes/Dataset.json | 8 ++++++++ 2 files changed, 11 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index cee38dda953a..2e32dcd12375 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -7007,6 +7007,7 @@ }, "headers": { "type": "object", + "x-ms-format": "dfe-key-value-pairs", "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)." }, "body": { @@ -8035,6 +8036,7 @@ }, "headers": { "type": "object", + "x-ms-format": "dfe-key-value-pairs", "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)." }, "body": { @@ -8100,6 +8102,7 @@ }, "headers": { "type": "object", + "x-ms-format": "dfe-key-value-pairs", "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)." }, "body": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json index 3a69786afcf8..47bca5e54132 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json @@ -516,6 +516,10 @@ "description": "Avro dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/AvroDatasetTypeProperties" + }, + "schema": { + "type": "object", + "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, @@ -756,6 +760,10 @@ "description": "Json dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/JsonDatasetTypeProperties" + }, + "schema": { + "type": "object", + "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, From 9f3512508d0b4a073825e5166a1a988a1babb2c4 Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Thu, 30 Nov 2023 10:24:42 +0800 Subject: [PATCH 09/11] fix swagger definition. --- .../stable/2018-06-01/entityTypes/Dataset.json | 2 +- .../stable/2020-12-01/entityTypes/Dataset.json | 8 -------- 2 files changed, 1 insertion(+), 9 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index 34bde7b55085..994500931e5b 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -38,7 +38,7 @@ }, "schema": { "type": "object", - "x-ms-format": "dfe-list-generic", + "x-ms-format": "dfe-object", "x-ms-format-element-type": "DatasetSchemaDataElement", "description": "Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement." }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json index 47bca5e54132..3a69786afcf8 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json @@ -516,10 +516,6 @@ "description": "Avro dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/AvroDatasetTypeProperties" - }, - "schema": { - "type": "object", - "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, @@ -760,10 +756,6 @@ "description": "Json dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/JsonDatasetTypeProperties" - }, - "schema": { - "type": "object", - "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, From 27fc75804fae39f2b6c5804d2ac44cc902329cbb Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Thu, 30 Nov 2023 13:22:03 +0800 Subject: [PATCH 10/11] fix snowflake linked service definition. --- .../stable/2018-06-01/entityTypes/LinkedService.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 6b3206c31265..15e195fe1943 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -7379,7 +7379,8 @@ "properties": { "connectionString": { "description": "The connection string of snowflake. Type: string, SecureString.", - "type": "object" + "type": "object", + "x-ms-format": "dfe-string" }, "password": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", From f85dddf283968237c34e2df934f0d830eddb9270 Mon Sep 17 00:00:00 2001 From: Bo Wang Date: Mon, 4 Dec 2023 10:50:20 +0800 Subject: [PATCH 11/11] fix dataset schema. --- .../stable/2018-06-01/entityTypes/Dataset.json | 8 -------- 1 file changed, 8 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index 994500931e5b..4e21c29e8722 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -605,10 +605,6 @@ "description": "Avro dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/AvroDatasetTypeProperties" - }, - "schema": { - "type": "object", - "description": "Columns that define the physical type schema of the dataset. Type: object" } } }, @@ -848,10 +844,6 @@ "description": "Json dataset properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/JsonDatasetTypeProperties" - }, - "schema": { - "type": "object", - "description": "Columns that define the physical type schema of the dataset. Type: object" } } },