Skip to content

update machine learning compute portion of the machine learning services swagger #3889

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

Merged
dsgouda merged 5 commits into from
Sep 19, 2018
Merged

update machine learning compute portion of the machine learning services swagger #3889

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
04ab6cb
update machine learning compute portion of the machine learning services
dagald-msft Sep 13, 2018
080f1c8
add systemUpdateCompute example
dagald-msft Sep 13, 2018
5271be5
update examples
dagald-msft Sep 13, 2018
4591722
added long-running op
dagald-msft Sep 13, 2018
b8420a3
remote wrong readOnly
dagald-msft Sep 14, 2018
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
Prev Previous commit
Next Next commit
added long-running op 
update accordingly
  • Loading branch information
@dagald-msft
dagald-msft committed Sep 13, 2018
commit 4591722b279f1148b3c6b3e2307a07f4843b4929
12 changes: 12 additions & 0 deletions ...ft.MachineLearningServices/preview/2018-03-01-preview/examples/createBasicAKSCompute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@
}
},
"responses": {
"200": {
"body": {
"id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"name": "compute123",
"location": "eastus",
"properties": {
"computeType": "AKS",
"provisioningState": "Creating"
}
}
},
"201": {
"body": {
"id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
Expand Down
12 changes: 12 additions & 0 deletions ...achineLearningServices/preview/2018-03-01-preview/examples/createBasicBatchAICompute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"name": "compute123",
"location": "eastus",
"properties": {
"computeType": "BatchAI",
"provisioningState": "Creating"
}
}
},
"201": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
Expand Down
12 changes: 12 additions & 0 deletions ...neLearningServices/preview/2018-03-01-preview/examples/createBasicDataFactoryCompute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"name": "compute123",
"location": "eastus",
"properties": {
"computeType": "DataFactory",
"provisioningState": "Creating"
}
}
},
"201": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
Expand Down
1 change: 1 addition & 0 deletions .../Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteCompute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"api-version": "2018-03-01-preview"
},
"responses": {
"200": {},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...",
Expand Down
1 change: 1 addition & 0 deletions ...soft.MachineLearningServices/preview/2018-03-01-preview/examples/systemUpdateCompute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"api-version": "2018-03-01-preview"
},
"responses": {
"200": {},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...",
Expand Down
14 changes: 14 additions & 0 deletions ...crosoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateAKSCompute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,20 @@
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"name": "compute123",
"location": "eastus",
"properties": {
"description": "some compute",
"resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2",
"computeType": "AKS",
"provisioningState": "Updating"
}
}
},
"201": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
Expand Down
14 changes: 14 additions & 0 deletions ...oft.MachineLearningServices/preview/2018-03-01-preview/examples/updateBatchAICompute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,20 @@
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
"type": "Microsoft.MachineLearningServices/workspaces/computes",
"name": "compute123",
"location": "eastus2",
"properties": {
"description": "some compute",
"resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.BatchAI/clusters/compute123-ccb488844dcc2",
"computeType": "BatchAI",
"provisioningState": "Updating"
}
}
},
"201": {
"body": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
Expand Down
15 changes: 15 additions & 0 deletions ...Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,7 @@
],
"operationId": "MachineLearningCompute_CreateOrUpdate",
"description": "Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.",
"x-ms-long-running-operation": true,
"x-ms-examples": {
"Create a BatchAI Compute": { "$ref": "./examples/createBasicBatchAICompute.json" },
"Create AKS Compute": { "$ref": "./examples/createBasicAKSCompute.json" },
Expand Down Expand Up @@ -529,6 +530,12 @@
}
],
"responses": {
"200": {
"description": "Compute creation or update initiated.",
"schema": {
"$ref": "#/definitions/ComputeResource"
}
},
"201": {
"description": "Compute creation or update initiated.",
"headers": {
Expand Down Expand Up @@ -556,6 +563,7 @@
],
"operationId": "MachineLearningCompute_Delete",
"description": "Deletes specified Machine Learning compute.",
"x-ms-long-running-operation": true,
"x-ms-examples": {
"Delete Compute": { "$ref": "./examples/deleteCompute.json" }
},
Expand All @@ -577,6 +585,9 @@
}
],
"responses": {
"200": {
"description": "The request was successful; the request was well-formed and received properly."
},
"202": {
"description": "Compute deletion initiated.",
"headers": {
Expand Down Expand Up @@ -605,6 +616,7 @@
],
"operationId": "MachineLearningCompute_SystemUpdate",
"description": "System Update On Machine Learning compute.",
"x-ms-long-running-operation": true,
"x-ms-examples": {
"System Update Compute": { "$ref": "./examples/systemUpdateCompute.json" }
},
Expand All @@ -626,6 +638,9 @@
}
],
"responses": {
"200": {
"description": "Compute System updated."
},
"202": {
"description": "Compute System Update initiated.",
Copy link
Contributor

@dsgouda dsgouda Sep 13, 2018

Choose a reason for hiding this comment

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

Is this and update for the MachineLearningCompute resource?
Update is usually a PATCH operation. Did this service undergo an API review?

Copy link
Contributor

@dsgouda dsgouda Sep 13, 2018

Choose a reason for hiding this comment

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

Also, 202 corresponds to Accepted which ideally should be a long running operation

Copy link
Author

@dagald dagald Sep 13, 2018

Choose a reason for hiding this comment

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

That is an update on an internal system that is deployed on top of the compute. Not the compute itself.

The swagger that was uploaded before was incorrect. And the service has gone to a lot of changes

"headers": {
Expand Down