Skip to content

Azure Machine Learning WebServicesRP new API version#1019

Merged
veronicagg merged 10 commits into
Azure:masterfrom
NonStatic2014:new_version
Mar 31, 2017
Merged

Azure Machine Learning WebServicesRP new API version#1019
veronicagg merged 10 commits into
Azure:masterfrom
NonStatic2014:new_version

Conversation

@NonStatic2014
Copy link
Copy Markdown
Contributor

@NonStatic2014 NonStatic2014 commented Mar 10, 2017

Azure Machine Learning is going to publish a new version 2017-01-01. This is the swagger for the new version. Most of the part is similar to the previous version in https://github.com/Azure/azure-rest-api-specs/blob/master/arm-machinelearning/2016-05-01-preview/swagger/webservices.json. I would recommend reviewers comparing with that file.

@NonStatic2014 NonStatic2014 changed the title Azure Machine Learning new API version Azure Machine Learning WebServicesRP new API version Mar 10, 2017
Copy link
Copy Markdown
Contributor

@sergey-shandar sergey-shandar left a comment

Choose a reason for hiding this comment

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

I'm not sure why the PR doesn't have a standard check list as other PRs do, for example #1045 (comment), but we still need to go through the list.

According to https://github.com/Azure/azure-rest-api-specs/blob/master/.github/CONTRIBUTING.md#filenames-and-folder-structure we should have a commit with the old version of the swagger file so we can see the changes. As a workaround, I've created a dummy branch to see the changes https://github.com/sergey-shandar/azure-rest-api-specs/pull/1/files.

],
"consumes": [
"application/json",
"text/json"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

],
"produces": [
"application/json",
"text/json"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

AutoRest doesn't support "text/json".

"tags": [
"WebServices"
],
"operationId": "WebServices_CreateOrUpdate",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"application/json",
"text/json"
],
"paths": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This service should also implement Operation API. It's an operation which returns a list of all service operations. See the example
https://github.com/Azure/azure-rest-api-specs/blob/master/arm-cdn/2016-10-02/swagger/cdn.json#L1578

From https://travis-ci.org/Azure/azure-rest-api-specs/jobs/209869904#L996

],
"responses": {
"200": {
"description": "Success. This response is returned for an update web service operation. The response payload is identical to the response payload that is returned by the GET operation. The response includes the Provisioning State and the Azure-AsyncOperation header. To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field. For more information about Asynchronous Operations, see https://msdn.microsoft.com/en-us/library/mt742920.aspx.",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Avoid MSDN references. For better generated code quality, remove all references to "msdn.microsoft.com".

From https://travis-ci.org/Azure/azure-rest-api-specs/jobs/209869904#L1007

"description": "Specifies the name of the resource.",
"type": "string"
},
"location": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The name property of the Resource must be read-only.

"type": "string",
"readOnly": true
},
"tags": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The tags property of the Resource must be read-only.

"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"operationId": "WebServices_List",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A Tracked Resource must have a ListBySubscriptionId operation with x-ms-pageable extension. I assume, the operationId should be renamed to "WebServices_ListBySubscriptionId".

From https://travis-ci.org/Azure/azure-rest-api-specs/jobs/209869904#L1128

"type": "boolean",
"description": "When set to true, indicates that the payload size is larger than 3 MB. Otherwise false. If the payload size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation parameter contains the URI of the blob. Otherwise, this will be set to false and Assets, Input, Output, Package, Parameters, ExampleRequest are inline. The Payload sizes is determined by adding the size of the Assets, Input, Output, Package, Parameters, and the ExampleRequest."
},
"PayloadsLocation": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the name should follow camel case style.

From https://travis-ci.org/Azure/azure-rest-api-specs/jobs/209869904#L1139

}
},
"definitions": {
"Resource": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The definition should have "description".

From https://travis-ci.org/Azure/azure-rest-api-specs/jobs/209869904#L1172

@cormacpayne
Copy link
Copy Markdown
Member

Spec used to generate Azure/azure-sdk-for-net#2921

@azuresdkci
Copy link
Copy Markdown
Contributor

Can one of the admins verify this patch?

@veronicagg veronicagg merged commit 17824f2 into Azure:master Mar 31, 2017
@AutorestCI
Copy link
Copy Markdown

No modification for Ruby

@AutorestCI
Copy link
Copy Markdown

No modification for NodeJS

@AutorestCI
Copy link
Copy Markdown

No modification for Python

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants