Skip to content

Commit c7ce6ad

Browse files
Bharath550-msBharath550-ms
authored
Spark Configuration DataPlane Api's Swagger Changes (#15085)
* Spark Configuration DataPlane Api's Swagger Changes Spark Configuration DataPlane Api's Swagger Changes * Spark Configuration DataPlane Api's Swagger Changes Spark Configuration DataPlane Api's Swagger Changes * Updated readme file Updated readme file * Fix CI Errors Fix CI Errors * Update readme.md Updated readme file * Fixed CI Errors Fixed CI Errors * Fixed comments Fixed comments * Added changes for new preview version Added changes for new preview version
1 parent 313e78f commit c7ce6ad

File tree

10 files changed

+556
-0
lines changed

10 files changed

+556
-0
lines changed

‎custom-words.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1758,6 +1758,8 @@ southcentralus
17581758
southeastasia
17591759
southindia
17601760
sparkconf
1761+
sparkconfiguration
1762+
sparkconfigurations
17611763
sparkr
17621764
sparql
17631765
SPDX

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

Lines changed: 271 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2897,6 +2897,231 @@
28972897
}
28982898
}
28992899
}
2900+
},
2901+
"/sparkconfigurations": {
2902+
"get": {
2903+
"tags": [
2904+
"sparkconfigurations"
2905+
],
2906+
"operationId": "SparkConfiguration_GetSparkConfigurationsByWorkspace",
2907+
"x-ms-examples": {
2908+
"SparkConfigurations_ListByWorkspace": {
2909+
"$ref": "./examples/SparkConfigurations_ListByWorkspace.json"
2910+
}
2911+
},
2912+
"description": "Lists sparkconfigurations.",
2913+
"parameters": [
2914+
{
2915+
"$ref": "#/parameters/ApiVersionParameter"
2916+
}
2917+
],
2918+
"responses": {
2919+
"200": {
2920+
"description": "OK.",
2921+
"schema": {
2922+
"$ref": "#/definitions/SparkConfigurationListResponse"
2923+
}
2924+
},
2925+
"default": {
2926+
"description": "An error response received from the Azure Synapse service.",
2927+
"schema": {
2928+
"$ref": "#/definitions/CloudError"
2929+
}
2930+
}
2931+
},
2932+
"x-ms-pageable": {
2933+
"nextLinkName": "nextLink"
2934+
}
2935+
}
2936+
},
2937+
"/sparkconfigurations/{sparkConfigurationName}": {
2938+
"put": {
2939+
"tags": [
2940+
"sparkconfigurations"
2941+
],
2942+
"operationId": "SparkConfiguration_CreateOrUpdateSparkConfiguration",
2943+
"x-ms-examples": {
2944+
"SparkConfigurations_Create": {
2945+
"$ref": "./examples/SparkConfigurations_Create.json"
2946+
},
2947+
"SparkConfigurations_Update": {
2948+
"$ref": "./examples/SparkConfigurations_Update.json"
2949+
}
2950+
},
2951+
"description": "Creates or updates a sparkconfiguration.",
2952+
"x-ms-long-running-operation": true,
2953+
"parameters": [
2954+
{
2955+
"$ref": "#/parameters/sparkConfigurationName"
2956+
},
2957+
{
2958+
"$ref": "#/parameters/ApiVersionParameter"
2959+
},
2960+
{
2961+
"name": "If-Match",
2962+
"in": "header",
2963+
"required": false,
2964+
"type": "string",
2965+
"x-ms-client-name": "IfMatch",
2966+
"description": "ETag of the sparkConfiguration entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update."
2967+
},
2968+
{
2969+
"name": "sparkConfiguration",
2970+
"description": "SparkConfiguration resource definition.",
2971+
"in": "body",
2972+
"required": true,
2973+
"schema": {
2974+
"$ref": "#/definitions/SparkConfigurationResource"
2975+
}
2976+
}
2977+
],
2978+
"responses": {
2979+
"200": {
2980+
"description": "OK.",
2981+
"schema": {
2982+
"$ref": "#/definitions/SparkConfigurationResource"
2983+
}
2984+
},
2985+
"202": {
2986+
"description": "Accepted."
2987+
},
2988+
"default": {
2989+
"description": "An error response received from the Azure Synapse service.",
2990+
"schema": {
2991+
"$ref": "#/definitions/CloudError"
2992+
}
2993+
}
2994+
}
2995+
},
2996+
"get": {
2997+
"tags": [
2998+
"sparkconfigurations"
2999+
],
3000+
"operationId": "SparkConfiguration_GetSparkConfiguration",
3001+
"x-ms-examples": {
3002+
"SparkConfigurations_Get": {
3003+
"$ref": "./examples/SparkConfigurations_Get.json"
3004+
}
3005+
},
3006+
"description": "Gets a sparkConfiguration.",
3007+
"parameters": [
3008+
{
3009+
"$ref": "#/parameters/sparkConfigurationName"
3010+
},
3011+
{
3012+
"$ref": "#/parameters/ApiVersionParameter"
3013+
},
3014+
{
3015+
"name": "If-None-Match",
3016+
"in": "header",
3017+
"required": false,
3018+
"type": "string",
3019+
"x-ms-client-name": "IfNoneMatch",
3020+
"description": "ETag of the sparkConfiguration entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned."
3021+
}
3022+
],
3023+
"responses": {
3024+
"200": {
3025+
"description": "OK.",
3026+
"schema": {
3027+
"$ref": "#/definitions/SparkConfigurationResource"
3028+
}
3029+
},
3030+
"304": {
3031+
"description": "Not modified."
3032+
},
3033+
"default": {
3034+
"description": "An error response received from the Azure Synapse service.",
3035+
"schema": {
3036+
"$ref": "#/definitions/CloudError"
3037+
}
3038+
}
3039+
}
3040+
},
3041+
"delete": {
3042+
"tags": [
3043+
"sparkconfigurations"
3044+
],
3045+
"operationId": "SparkConfiguration_DeleteSparkConfiguration",
3046+
"x-ms-examples": {
3047+
"SparkConfigurations_Delete": {
3048+
"$ref": "./examples/SparkConfigurations_Delete.json"
3049+
}
3050+
},
3051+
"description": "Deletes a sparkConfiguration.",
3052+
"x-ms-long-running-operation": true,
3053+
"parameters": [
3054+
{
3055+
"$ref": "#/parameters/sparkConfigurationName"
3056+
},
3057+
{
3058+
"$ref": "#/parameters/ApiVersionParameter"
3059+
}
3060+
],
3061+
"responses": {
3062+
"200": {
3063+
"description": "OK."
3064+
},
3065+
"202": {
3066+
"description": "Accepted."
3067+
},
3068+
"204": {
3069+
"description": "No Content."
3070+
},
3071+
"default": {
3072+
"description": "An error response received from the Azure Synapse service.",
3073+
"schema": {
3074+
"$ref": "#/definitions/CloudError"
3075+
}
3076+
}
3077+
}
3078+
}
3079+
},
3080+
"/sparkconfigurations/{sparkConfigurationName}/rename": {
3081+
"post": {
3082+
"tags": [
3083+
"sparkconfigurations"
3084+
],
3085+
"operationId": "SparkConfiguration_RenameSparkConfiguration",
3086+
"x-ms-examples": {
3087+
"SparkConfigurations_Rename": {
3088+
"$ref": "./examples/SparkConfigurations_Rename.json"
3089+
}
3090+
},
3091+
"description": "Renames a sparkConfiguration.",
3092+
"x-ms-long-running-operation": true,
3093+
"parameters": [
3094+
{
3095+
"$ref": "#/parameters/sparkConfigurationName"
3096+
},
3097+
{
3098+
"$ref": "#/parameters/ApiVersionParameter"
3099+
},
3100+
{
3101+
"name": "request",
3102+
"description": "proposed new name.",
3103+
"in": "body",
3104+
"required": true,
3105+
"schema": {
3106+
"$ref": "#/definitions/ArtifactRenameRequest"
3107+
}
3108+
}
3109+
],
3110+
"responses": {
3111+
"200": {
3112+
"description": "OK."
3113+
},
3114+
"202": {
3115+
"description": "Accepted."
3116+
},
3117+
"default": {
3118+
"description": "An error response received from the Azure Synapse service.",
3119+
"schema": {
3120+
"$ref": "#/definitions/CloudError"
3121+
}
3122+
}
3123+
}
3124+
}
29003125
}
29013126
},
29023127
"definitions": {
@@ -3133,6 +3358,44 @@
31333358
}
31343359
}
31353360
},
3361+
"SparkConfigurationListResponse": {
3362+
"description": "A list of sparkconfiguration resources.",
3363+
"type": "object",
3364+
"required": [
3365+
"value"
3366+
],
3367+
"properties": {
3368+
"value": {
3369+
"type": "array",
3370+
"description": "List of sparkconfigurations.",
3371+
"items": {
3372+
"$ref": "#/definitions/SparkConfigurationResource"
3373+
}
3374+
},
3375+
"nextLink": {
3376+
"description": "The link to the next page of results, if any remaining results exist.",
3377+
"type": "string"
3378+
}
3379+
}
3380+
},
3381+
"SparkConfigurationResource": {
3382+
"description": "Spark Configuration resource type.",
3383+
"type": "object",
3384+
"allOf": [
3385+
{
3386+
"$ref": "#/definitions/SubResource"
3387+
}
3388+
],
3389+
"properties": {
3390+
"properties": {
3391+
"$ref": "./entityTypes/SparkConfiguration.json#/definitions/SparkConfiguration",
3392+
"description": "Properties of Spark Configuration."
3393+
}
3394+
},
3395+
"required": [
3396+
"properties"
3397+
]
3398+
},
31363399
"CreateDataFlowDebugSessionRequest": {
31373400
"description": "Request body structure for creating data flow debug session.",
31383401
"type": "object",
@@ -4919,6 +5182,14 @@
49195182
"type": "string",
49205183
"x-ms-parameter-location": "method"
49215184
},
5185+
"sparkConfigurationName": {
5186+
"name": "sparkConfigurationName",
5187+
"description": "The spark Configuration name.",
5188+
"in": "path",
5189+
"required": true,
5190+
"type": "string",
5191+
"x-ms-parameter-location": "method"
5192+
},
49225193
"NotebookName": {
49235194
"name": "notebookName",
49245195
"description": "The notebook name.",

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

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"title": "ArtifactsClient",
5+
"version": "2021-06-01-preview"
6+
},
7+
"paths": {},
8+
"definitions": {
9+
"SparkConfiguration": {
10+
"type": "object",
11+
"description": "SparkConfiguration Artifact information",
12+
"title": "Information about a SparkConfiguration created at the workspace level.",
13+
"properties": {
14+
"description": {
15+
"type": "string",
16+
"description": "Description about the SparkConfiguration."
17+
},
18+
"configs": {
19+
"type": "object",
20+
"description": "SparkConfiguration configs.",
21+
"additionalProperties": {
22+
"type": "string"
23+
}
24+
},
25+
"annotations": {
26+
"type": "array",
27+
"items": {
28+
"type": "string"
29+
},
30+
"description": "Annotations for SparkConfiguration."
31+
},
32+
"notes": {
33+
"type": "string",
34+
"description": "additional Notes."
35+
},
36+
"createdBy": {
37+
"type": "string",
38+
"description": "The identity that created the resource."
39+
},
40+
"created": {
41+
"type": "string",
42+
"format": "date-time",
43+
"description": "The timestamp of resource creation."
44+
}
45+
},
46+
"required": [
47+
"configs"
48+
]
49+
}
50+
}
51+
}

0 commit comments

Comments
 (0)