Skip to content

Create AzureMachineLearning.json data-plane API.#5734

Merged
sergey-shandar merged 63 commits intoAzure:masterfrom
hendrytl:machine-learning-data-plane-new
Aug 14, 2019
Merged

Create AzureMachineLearning.json data-plane API.#5734
sergey-shandar merged 63 commits intoAzure:masterfrom
hendrytl:machine-learning-data-plane-new

Conversation

@hendrytl
Copy link
Copy Markdown
Contributor

@hendrytl hendrytl commented Apr 22, 2019

Initial version of data plane swagger.
This API is pending review by the API Review Board.

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and have all been fixed in this PR.
  • The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
  • adding/removing APIs.
  • adding/removing properties.
  • adding/removing API-version.
  • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

@AutorestCI
Copy link
Copy Markdown

AutorestCI commented Apr 22, 2019

Automation for azure-sdk-for-js

Nothing to generate for azure-sdk-for-js

@AutorestCI
Copy link
Copy Markdown

AutorestCI commented Apr 22, 2019

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

@AutorestCI
Copy link
Copy Markdown

AutorestCI commented Apr 22, 2019

Automation for azure-sdk-for-python

Nothing to generate for azure-sdk-for-python

@azuresdkci
Copy link
Copy Markdown
Contributor

Can one of the admins verify this patch?

Copy link
Copy Markdown
Contributor

@nschonni nschonni 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 guessing the suggestions will only make sense looking at the files tab. GitHub has a hard time with large files and Suggestions

@AutorestCI
Copy link
Copy Markdown

AutorestCI commented Apr 22, 2019

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

@AutorestCI
Copy link
Copy Markdown

AutorestCI commented Apr 23, 2019

Automation for azure-sdk-for-java

Nothing to generate for azure-sdk-for-java

@hendrytl
Copy link
Copy Markdown
Contributor Author

hendrytl commented Apr 23, 2019

@nschonni @veronicagg The model validation check is failing with
"fatal error: xmsExampleFunc is not a function, {}
##[error]Bash exited with code '1'."
Any ideas what the issue is or how to troubleshoot?
Update:
I removed the x-ms-example tags from the operations and the error went away.

Copy link
Copy Markdown
Contributor

@veronicagg veronicagg left a comment

Choose a reason for hiding this comment

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

Are you creating this version based on an existing API version? which one? In order to get a better diff for review, we ask to have a commit first with the API version you copied from and then make the updates. You can use aka.ms/openapihub to Create API version based on existing, which will help making the commits I mentioned above and updating API versions as well as example files.

Please also update the readme.md file with the new file and a tag for this package.
Thanks!

@hendrytl
Copy link
Copy Markdown
Contributor Author

hendrytl commented Apr 24, 2019 via email

@veronicagg
Copy link
Copy Markdown
Contributor

veronicagg commented Apr 25, 2019

@hendrytl Thanks for pointing out the scenario in openapihub, I'll follow up. I see that you added the readme already, and thanks for clarifying that you're not planning on having auto-generated SDKs. thanks!

@veronicagg
Copy link
Copy Markdown
Contributor

@veronicagg veronicagg added the APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. label Apr 25, 2019
Comment thread specification/machinelearningservices/data-plane/readme.md Outdated
@hendrytl
Copy link
Copy Markdown
Contributor Author

hendrytl commented Apr 25, 2019 via email

@hendrytl
Copy link
Copy Markdown
Contributor Author

hendrytl commented Apr 25, 2019 via email

@veronicagg
Copy link
Copy Markdown
Contributor

@hendrytl ok, we prefer to have examples checked in with the specs, if you think you won't make that, you can add examples later, please know that if you're planning to generate documentation, it will be missing examples. The error for x-ms-examples required will be reported until they are added.
Also, your suppression for the error on the delete operation was approved, feel free to add it back to the readme.md file.

@veronicagg
Copy link
Copy Markdown
Contributor

@hendrytl this PR is fine from my side, pending approval from API review board. thanks!

@veronicagg
Copy link
Copy Markdown
Contributor

@hendrytl any updates on this PR? are you going through API review?

@hendrytl
Copy link
Copy Markdown
Contributor Author

hendrytl commented May 3, 2019 via email

@veronicagg veronicagg assigned amarzavery and unassigned veronicagg May 20, 2019
@veronicagg
Copy link
Copy Markdown
Contributor

@hendrytl I'm changing roles, so I'm assigning this review to @amarzavery to help you complete it. Let us know if you'll be making more changes or we should take another look. Thanks!

@hendrytl hendrytl requested a review from veronicagg May 22, 2019 16:35
@amarzavery
Copy link
Copy Markdown
Contributor

spell check issues that need to be fixed.

specification/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-05-01/hyperdrive.json:54:32 - Unknown word (experiement)
specification/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-05-01/hyperdrive.json:107:32 - Unknown word (experiement)

@veronicagg veronicagg removed their request for review August 2, 2019 23:09
@veronicagg veronicagg dismissed their stale review August 2, 2019 23:10

I'm not required to review this PR as I'm not longer in the team responsible for the review

@johanste johanste removed the APIStewardshipBoard-ReviewRequested This should be reviewed by the Azure API Stewardship team in partnership with the service team. label Aug 2, 2019
@johanste
Copy link
Copy Markdown
Member

johanste commented Aug 2, 2019

The swagger looks correct. There may be some custom extensions needed to optimize code generation. @amarzavery , once you get go-ahead, can you double-check readme.ms:s and merge if everything looks good?

@sergey-shandar sergey-shandar merged commit d3b059d into Azure:master Aug 14, 2019
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.