Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Synapse] Support long running operation and add subclass of Activity in artifact #10270

Merged
merged 6 commits into from
Aug 3, 2020
Merged

[Synapse] Support long running operation and add subclass of Activity in artifact #10270

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
63c8304
change response status code
Jul 27, 2020
4332e18
add activities
Jul 27, 2020
6554962
fix ModelValidation and PrettierCheck
Jul 28, 2020
67ca102
long running operation
Jul 31, 2020
b580ae6
fix description
Jul 31, 2020
412df72
fix tab
Jul 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 90 additions & 18 deletions specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@
}
],
"responses": {
"200": {
"description": "OK.",
"202": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need more context here, does it mean it was wrong to say that the server was returning a 200? Or did you change the API to return a 202? Could you describe a little more if your 202 is pollable (have a Location header, etc.)

We can have this discussion by email if you anticipate it to be long.
Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We got the Swagger spec for our RP devs. According to our tests, the Swagger spec is incorrect. The server is actually returning 202 rather than 200. The response is pollable, we do have a Location header in the response. Let me know if you need more info.

"description": "Request is queued successfully.",
"schema": {
"$ref": "#/definitions/LinkedServiceResource"
}
Expand Down Expand Up @@ -180,8 +180,8 @@
}
],
"responses": {
"200": {
"description": "OK."
"202": {
"description": "Request is queued successfully."
},
"204": {
"description": "No Content."
Expand Down Expand Up @@ -440,8 +440,8 @@
}
],
"responses": {
"200": {
"description": "OK.",
"202": {
"description": "Request is queued successfully.",
"schema": {
"$ref": "#/definitions/PipelineResource"
}
Expand Down Expand Up @@ -518,8 +518,8 @@
}
],
"responses": {
"200": {
"description": "OK."
"202": {
"description": "Request is queued successfully."
},
"204": {
"description": "No Content."
Expand Down Expand Up @@ -587,8 +587,8 @@
}
],
"responses": {
"200": {
"description": "OK.",
"202": {
"description": "Request is queued successfully.",
"schema": {
"$ref": "#/definitions/CreateRunResponse"
}
Expand Down Expand Up @@ -844,8 +844,8 @@
}
],
"responses": {
"200": {
"description": "OK.",
"202": {
"description": "Request is queued successfully.",
"schema": {
"$ref": "#/definitions/TriggerResource"
}
Expand Down Expand Up @@ -922,8 +922,8 @@
}
],
"responses": {
"200": {
"description": "OK."
"202": {
"description": "Request is queued successfully."
},
"204": {
"description": "No Content."
Expand Down Expand Up @@ -2134,8 +2134,8 @@
}
],
"responses": {
"200": {
"description": "OK.",
"202": {
"description": "Request is queued successfully.",
"schema": {
"$ref": "#/definitions/NotebookResource"
}
Expand Down Expand Up @@ -2212,8 +2212,8 @@
}
],
"responses": {
"200": {
"description": "OK."
"202": {
"description": "Request is queued successfully."
},
"204": {
"description": "No Content."
Expand Down Expand Up @@ -4130,6 +4130,78 @@
"readOnly": true
}
}
},
"SynapseNotebookReference": {
"description": "Synapse notebook reference type.",
"properties": {
"type": {
"type": "string",
"description": "Synapse notebook reference type.",
"enum": [
"NotebookReference"
],
"x-ms-enum": {
"name": "NotebookReferenceType",
"modelAsString": true
}
},
"referenceName": {
"type": "string",
"description": "Reference notebook name."
}
},
"required": [
"type",
"referenceName"
]
},
"SynapseSparkJobReference": {
"description": "Synapse spark job reference type.",
"properties": {
"type": {
"type": "string",
"description": "Synapse spark job reference type.",
"enum": [
"SparkJobDefinitionReference"
],
"x-ms-enum": {
"name": "SparkJobReferenceType",
"modelAsString": true
}
},
"referenceName": {
"type": "string",
"description": "Reference spark job name."
}
},
"required": [
"type",
"referenceName"
]
},
"SqlPoolReference": {
"description": "SQL pool reference type.",
"properties": {
"type": {
"type": "string",
"description": "SQL pool reference type.",
"enum": [
"SqlPoolReference"
],
"x-ms-enum": {
"name": "SqlPoolReferenceType",
"modelAsString": true
}
},
"referenceName": {
"type": "string",
"description": "Reference SQL pool name."
}
},
"required": [
"type",
"referenceName"
]
}
},
"parameters": {
Expand Down
109 changes: 109 additions & 0 deletions ...synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5831,6 +5831,115 @@
"required": [
"dataFlow"
]
},
"SynapseNotebookActivity": {
"description": "Execute Synapse notebook activity.",
"x-ms-discriminator-value": "SynapseNotebook",
"allOf": [
{
"$ref": "#/definitions/Activity"
}
],
"properties": {
"typeProperties": {
"x-ms-client-flatten": true,
"description": "Execute Synapse notebook activity properties.",
"$ref": "#/definitions/SynapseNotebookActivityTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"SynapseNotebookActivityTypeProperties": {
"description": "Execute Synapse notebook activity properties.",
"properties": {
"notebook": {
"description": "Synapse notebook reference.",
"$ref": "../artifacts.json#/definitions/SynapseNotebookReference"
},
"parameters": {
"description": "Notebook parameters.",
"$ref": "../artifacts.json#/definitions/ParameterValueSpecification"
}
},
"required": [
"notebook"
]
},
"SynapseSparkJobDefinitionActivity": {
"description": "Execute spark job activity.",
"x-ms-discriminator-value": "SparkJob",
"allOf": [
{
"$ref": "#/definitions/Activity"
}
],
"properties": {
"typeProperties": {
"x-ms-client-flatten": true,
"description": "Execute spark job activity properties.",
"$ref": "#/definitions/SynapseSparkJobActivityTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"SynapseSparkJobActivityTypeProperties": {
"description": "Execute spark job activity properties.",
"properties": {
"sparkJob": {
"description": "Synapse spark job reference.",
"$ref": "../artifacts.json#/definitions/SynapseSparkJobReference"
}
},
"required": [
"sparkJob"
]
},
"SqlPoolStoredProcedureActivity": {
"description": "Execute SQL pool stored procedure activity.",
"x-ms-discriminator-value": "SqlPoolStoredProcedure",
"allOf": [
{
"$ref": "#/definitions/Activity"
}
],
"properties": {
"sqlPool": {
"description": "SQL pool stored procedure reference.",
"$ref": "../artifacts.json#/definitions/SqlPoolReference"
},
"typeProperties": {
"x-ms-client-flatten": true,
"description": "Execute SQL pool stored procedure activity properties.",
"$ref": "#/definitions/SqlPoolStoredProcedureActivityTypeProperties"
}
},
"required": [
"sqlPool",
"typeProperties"
]
},
"SqlPoolStoredProcedureActivityTypeProperties": {
"description": "SQL stored procedure activity properties.",
"properties": {
"storedProcedureName": {
"type": "object",
"description": "Stored procedure name. Type: string (or Expression with resultType string)."
},
"storedProcedureParameters": {
"description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/StoredProcedureParameter"
}
}
},
"required": [
"storedProcedureName"
]
}
}
}
2 changes: 1 addition & 1 deletion ...ta-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {
"202": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:37:34 GMT",
"X-Content-Type-Options": "nosniff",
Expand Down
2 changes: 1 addition & 1 deletion ...ta-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
2 changes: 1 addition & 1 deletion ...ta-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {
"202": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:37:36 GMT",
"X-Content-Type-Options": "nosniff",
Expand Down
2 changes: 1 addition & 1 deletion ...se/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {
"202": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:37:41 GMT",
"X-Content-Type-Options": "nosniff",
Expand Down
2 changes: 1 addition & 1 deletion ...se/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
2 changes: 1 addition & 1 deletion ...se/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {
"202": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:37:41 GMT",
"X-Content-Type-Options": "nosniff",
Expand Down
2 changes: 1 addition & 1 deletion ...se/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {
"202": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:37:41 GMT",
"X-Content-Type-Options": "nosniff",
Expand Down
2 changes: 1 addition & 1 deletion ...data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {
"202": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:37:48 GMT",
"X-Content-Type-Options": "nosniff",
Expand Down
2 changes: 1 addition & 1 deletion ...se/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
2 changes: 1 addition & 1 deletion ...se/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {
"202": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:37:43 GMT",
"X-Content-Type-Options": "nosniff",
Expand Down
2 changes: 1 addition & 1 deletion ...pse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"api-version": "2019-06-01-preview"
},
"responses": {
"200": {
"202": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:40:14 GMT",
"X-Content-Type-Options": "nosniff",
Expand Down
Loading