Skip to content

Commit bfc5270

Browse files
piyushdubeyharryli0108
piyushdubey
authored and
harryli0108
committed
SyMS Service API Swagger Client [2023] (Azure#23180)
* SyMS Service API Swagger Client Spec * Add SyMS specific custom words + readme * SyMS: Fix LintDiff errors * SyMS: Fix LintDiff and Model Validation errors * SyMS: Fix Model Validation errors * SyMS: Fix Model Validation errors * SyMS: Fix Model Validation errors * SyMS: Suppress Model Validation Errors * SyMS: Fix Model Validation errors * SyMS: Fix Model Validation errors * SyMS: Fix Model Validation errors * SyMS: Remove Model Validation Errors suppression. Not needed anymore * SyMS: Move file to latest SDK version
1 parent 1714e73 commit bfc5270

22 files changed

+3179
-1
lines changed

‎custom-words.txt‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2829,4 +2829,13 @@ Hnsw
28292829
Piqd
28302830
Reranked
28312831
Reranking
2832-
contentsafety
2832+
contentsafety
2833+
msapi
2834+
msapiddl
2835+
partitioninfo
2836+
ddls
2837+
serde
2838+
onetoone
2839+
onetomany
2840+
manytoone
2841+
manytomany

‎specification/synapse/data-plane/Microsoft.Synapse/stable/2021-04-01/examples/DeleteArtifactForDB.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"parameters": {
3+
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
4+
"databaseName": "exampleDatabase",
5+
"artifactType": "TABLE",
6+
"artifactName": "exampleTableName",
7+
"api-version": "2021-04-01"
8+
},
9+
"responses": {
10+
"200": {},
11+
"default": {
12+
"body": {
13+
"error": {
14+
"code": "Error code",
15+
"message": "SyMS response error message"
16+
}
17+
}
18+
}
19+
}
20+
}

‎specification/synapse/data-plane/Microsoft.Synapse/stable/2021-04-01/examples/DeleteArtifactFromSchema.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"parameters": {
3+
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
4+
"databaseName": "exampleDatabase",
5+
"schemaName": "exampleSchemaName",
6+
"artifactType": "TABLE",
7+
"artifactName": "exampleArtifactName",
8+
"api-version": "2021-04-01"
9+
},
10+
"responses": {
11+
"200": {},
12+
"default": {
13+
"body": {
14+
"error": {
15+
"code": "Error code",
16+
"message": "SyMS response error message"
17+
}
18+
}
19+
}
20+
}
21+
}

‎specification/synapse/data-plane/Microsoft.Synapse/stable/2021-04-01/examples/DeleteDatabase.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"parameters": {
3+
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
4+
"databaseName": "exampleDatabase",
5+
"api-version": "2021-04-01"
6+
},
7+
"responses": {
8+
"200": {},
9+
"default": {
10+
"body": {
11+
"error": {
12+
"code": "Error code",
13+
"message": "SyMS response error message"
14+
}
15+
}
16+
}
17+
}
18+
}

‎specification/synapse/data-plane/Microsoft.Synapse/stable/2021-04-01/examples/ExecuteChange.json‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"parameters": {
3+
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
4+
"createArtifactsPayload": {
5+
"ddls": [
6+
{
7+
"actionType": "CREATE",
8+
"oldEntity": null,
9+
"newEntity": {
10+
"name": "dummyDatabase",
11+
"type": "DATABASE"
12+
}
13+
}
14+
]
15+
},
16+
"api-version": "2021-04-01"
17+
},
18+
"responses": {
19+
"200": {
20+
"body": {
21+
"syMsApiDdlResponse": [
22+
{
23+
"ddlType": "CREATE",
24+
"entityName": "exampleEntity1",
25+
"entityType": "DATABASE",
26+
"publishStatus": "PUBLISHED",
27+
"originObjectId": "exampleOriginObjectId1",
28+
"objectId": "exampleObjectId",
29+
"objectVersion": 1
30+
}
31+
]
32+
}
33+
},
34+
"default": {
35+
"body": {
36+
"error": {
37+
"code": "Error code",
38+
"message": "Error message"
39+
}
40+
}
41+
}
42+
}
43+
}

‎specification/synapse/data-plane/Microsoft.Synapse/stable/2021-04-01/examples/ExecuteChangeWithValidation.json‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"parameters": {
3+
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
4+
"createArtifactsPayload": {
5+
"ddls": [
6+
{
7+
"actionType": "CREATE",
8+
"oldEntity": null,
9+
"newEntity": {
10+
"name": "dummyDatabase",
11+
"type": "DATABASE"
12+
}
13+
}
14+
]
15+
},
16+
"validationType": "IDWValidation",
17+
"api-version": "2021-04-01"
18+
},
19+
"responses": {
20+
"202": {
21+
"headers": {
22+
"Operation-Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2020-07-01"
23+
}
24+
},
25+
"default": {
26+
"body": {
27+
"error": {
28+
"code": "Error code",
29+
"message": "Error message"
30+
}
31+
}
32+
}
33+
}
34+
}

‎specification/synapse/data-plane/Microsoft.Synapse/stable/2021-04-01/examples/GetArtifactFromDB.json‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
{
2+
"parameters": {
3+
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
4+
"databaseName": "exampleDatabase",
5+
"artifactType": "TABLE",
6+
"artifactName": "exampleTableName",
7+
"api-version": "2021-04-01"
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"name": "exampleTableName",
13+
"type": "TABLE",
14+
"properties": {
15+
"TableType": "MANAGED",
16+
"Namespace": {
17+
"SchemaName": null,
18+
"DatabaseName": "exampleDatabase"
19+
},
20+
"partitioning": null,
21+
"storageDescriptor": {
22+
"distribution": null,
23+
"columns": [
24+
{
25+
"name": "exampleColumn1Name",
26+
"originDataTypeName": {
27+
"typeFamily": null,
28+
"typeName": "string",
29+
"isTableType": false,
30+
"isComplexType": false,
31+
"isNullable": true,
32+
"length": 0,
33+
"precision": 0,
34+
"scale": 0,
35+
"properties": null
36+
}
37+
},
38+
{
39+
"name": "exampleColumn2Name",
40+
"originDataTypeName": {
41+
"typeFamily": null,
42+
"typeName": "string",
43+
"isTableType": false,
44+
"isComplexType": false,
45+
"isNullable": true,
46+
"length": 0,
47+
"precision": 0,
48+
"scale": 0,
49+
"properties": null
50+
}
51+
}
52+
],
53+
"columnSetEntityName": "ColumnSetEntityNameGuid",
54+
"format": {
55+
"inputFormat": "org.apache.hadoop.mapred.TextInputFormat",
56+
"outputFormat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
57+
"formatType": "textfile",
58+
"properties": {
59+
"serialization.format": "1"
60+
},
61+
"serDeName": null,
62+
"serializeLib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe"
63+
},
64+
"source": {
65+
"provider": null,
66+
"location": "abfss://exampleBlobContainer@exampleStorageName.dfs.core.windows.net/exampleDatabase/exampleTableName",
67+
"properties": null
68+
},
69+
"properties": {
70+
"microsoft.catalog.internal.hive.sd.columns": "{\"columns\":[{\"name\":\"exampleColumn1Name\",\"type\":\"string\"},{\"name\":\"exampleColumn2Name\",\"type\":\"string\"}]}"
71+
},
72+
"serDeInfo": null,
73+
"isStoredAsSubdirectories": false
74+
},
75+
"temporary": false,
76+
"isRewriteEnabled": false,
77+
"viewOriginalText": null,
78+
"viewExpandedText": null,
79+
"originObjectId": null,
80+
"isSharedEntity": false,
81+
"publishStatus": "PUBLISHED",
82+
"properties": {
83+
"spark.sql.sources.schema.part.0": "{\"type\":\"struct\",\"fields\":[{\"name\":\"exampleColumn1Name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}},{\"name\":\"exampleColumn2Name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}}]}",
84+
"transient_lastDdlTime": "1646776703",
85+
"spark.sql.sources.schema.numParts": "1",
86+
"spark.sql.create.version": "3.1.2.5.0-57012673"
87+
},
88+
"objectVersion": 1,
89+
"objectId": "2fe342ca-9c81-4d5b-8aeb-6259b02b99e6"
90+
},
91+
"id": "/subscriptions/exampleSubscriptionIdGuid/resourcegroups/exampleResourceGroup/providers/microsoft.synapse/workspaces/exampleWorkspace/databases/exampleDatabase/exampleTableName"
92+
}
93+
},
94+
"default": {
95+
"body": {
96+
"error": {
97+
"code": "Error code",
98+
"message": "SyMS response error message"
99+
}
100+
}
101+
}
102+
}
103+
}

‎specification/synapse/data-plane/Microsoft.Synapse/stable/2021-04-01/examples/GetArtifactFromSchema.json‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
{
2+
"parameters": {
3+
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
4+
"databaseName": "exampleDatabase",
5+
"schemaName": "exampleSchemaName",
6+
"artifactType": "TABLE",
7+
"artifactName": "exampleArtifactName",
8+
"api-version": "2021-04-01"
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"name": "exampleTableName",
14+
"type": "TABLE",
15+
"properties": {
16+
"TableType": "MANAGED",
17+
"Namespace": {
18+
"SchemaName": "exampleSchemaName",
19+
"DatabaseName": "exampleDatabase"
20+
},
21+
"partitioning": null,
22+
"storageDescriptor": {
23+
"distribution": null,
24+
"columns": [
25+
{
26+
"name": "exampleColumn1Name",
27+
"originDataTypeName": {
28+
"typeFamily": null,
29+
"typeName": "string",
30+
"isTableType": false,
31+
"isComplexType": false,
32+
"isNullable": true,
33+
"length": 0,
34+
"precision": 0,
35+
"scale": 0,
36+
"properties": null
37+
}
38+
},
39+
{
40+
"name": "exampleColumn2Name",
41+
"originDataTypeName": {
42+
"typeFamily": null,
43+
"typeName": "string",
44+
"isTableType": false,
45+
"isComplexType": false,
46+
"isNullable": true,
47+
"length": 0,
48+
"precision": 0,
49+
"scale": 0,
50+
"properties": null
51+
}
52+
}
53+
],
54+
"columnSetEntityName": "ColumnSetEntityNameGuid",
55+
"format": {
56+
"inputFormat": "org.apache.hadoop.mapred.TextInputFormat",
57+
"outputFormat": "org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat",
58+
"formatType": "textfile",
59+
"properties": {
60+
"serialization.format": "1"
61+
},
62+
"serDeName": null,
63+
"serializeLib": "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe"
64+
},
65+
"source": {
66+
"provider": null,
67+
"location": "abfss://exampleBlobContainer@exampleStorageName.dfs.core.windows.net/exampleDatabase/exampleTableName",
68+
"properties": null
69+
},
70+
"properties": {
71+
"microsoft.catalog.internal.hive.sd.columns": "{\"columns\":[{\"name\":\"exampleColumn1Name\",\"type\":\"string\"},{\"name\":\"exampleColumn2Name\",\"type\":\"string\"}]}"
72+
},
73+
"serDeInfo": null
74+
},
75+
"temporary": false,
76+
"isRewriteEnabled": false,
77+
"viewOriginalText": null,
78+
"viewExpandedText": null,
79+
"originObjectId": null,
80+
"isSharedEntity": false,
81+
"publishStatus": "PUBLISHED",
82+
"properties": {
83+
"spark.sql.sources.schema.part.0": "{\"type\":\"struct\",\"fields\":[{\"name\":\"exampleColumn1Name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}},{\"name\":\"exampleColumn2Name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}}]}",
84+
"transient_lastDdlTime": "1646776703",
85+
"spark.sql.sources.schema.numParts": "1",
86+
"spark.sql.create.version": "3.1.2.5.0-57012673"
87+
},
88+
"objectVersion": 1,
89+
"objectId": "2fe342ca-9c81-4d5b-8aeb-6259b02b99e6"
90+
},
91+
"id": "/subscriptions/exampleSubscriptionIdGuid/resourcegroups/exampleResourceGroup/providers/microsoft.synapse/workspaces/exampleWorkspace/databases/exampleDatabase/exampleSchemaName"
92+
}
93+
},
94+
"default": {
95+
"body": {
96+
"error": {
97+
"code": "Error code",
98+
"message": "SyMS response error message"
99+
}
100+
}
101+
}
102+
}
103+
}

0 commit comments

Comments
 (0)