[Microsoft.MachineLearningServices] Add minLength:1 prop to required strings in 2023-04-01 #23109
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @forteddyt Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| mfe.json | 2023-04-01(dccbb37) | 2022-10-01(main) |
| mfe.json | 2023-04-01(dccbb37) | 2023-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 21 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 21 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L12:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L67:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L290:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/codes/{codeName}/versions/{version}' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L365:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L609:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L664:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L887:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/components/{componentName}/versions/{version}' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L962:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L1206:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L1289:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L1513:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/data/{name}/versions/{version}' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L1622:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L1867:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L1949:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L2172:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/environments/{environmentName}/versions/{version}' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L2274:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L2518:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L2600:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L2823:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}/models/{modelName}/versions/{version}' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L2949:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/featuresets' removed or restructured? Old: Microsoft.MachineLearningServices/preview/2023-02-01-preview/mfe.json#L6437:5 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-04 | package-2023-04(dccbb37) | package-2023-04(release-machinelearningservices-Microsoft.MachineLearningServices-2023-04-01) |
The following errors/warnings exist before current PR submission:
Only 21 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L12 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L70 |
|
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L70 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L71 |
|
A 'delete' operation 'BatchEndpoints_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L71 |
|
The patch operation body parameter schema should contains property 'sku'. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L226 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L278 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L360 |
|
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L360 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L431 |
|
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L431 |
|
The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L431 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L432 |
|
A 'delete' operation 'BatchDeployments_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L432 |
|
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L609 |
|
The patch operation body parameter schema should contains property 'sku'. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L609 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L661 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L751 |
|
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L751 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L803 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-04-01/mfe.json#L854 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 30 Errors, 0 Warnings failed [Detail]
Only 21 items are listed, please refer to log for more details.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
forteddyt
changed the title
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @forteddyt, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
|
Hi @forteddyt, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Mar 15, 2023
This was referenced Mar 15, 2023
JeffreyRichter
added
the
Approved-BreakingChange
ArcturusZhang
approved these changes
Mar 17, 2023
ArcturusZhang
merged commit f5b686a
into
Azure:release-machinelearningservices-Microsoft.MachineLearningServices-2023-04-01
ArcturusZhang
pushed a commit
that referenced
this pull request
Apr 18, 2023
…023 04 01 (#23450) * Adds base for updating Microsoft.MachineLearningServices from version stable/2022-10-01 to version 2023-04-01 * Updates readme * Updates API version in new specs and examples * [Stable] Bring Back schedule shutdown MLC models (#23039) * bring back schedule shutdown MLC models * add description --------- Co-authored-by: Naman Agarwal <naagarw@microsoft.com> * add minLength:1 prop to required strings (#23109) * [Stable] Add IdleShutdown properties and api (#23042) * [Stable] Add IdleShutdown properties and api * update version * remove api to update IdleShutdownSetting * Delete example --------- Co-authored-by: Naman Agarwal <naagarw@microsoft.com> * Pushing new features in stable swagger (#23071) * Pushing new features in stable swagger * Added example file * Triggering retest * Fixed version issue * Triggering retest * Removing OS Patching * Changes as per feedback, and add os patching back * Fix formatting * Removed Custom Service Update API * Fixed Example Files * Added as per review comments * Added as per review comments * Retrigger test --------- Co-authored-by: Srivatsa Sinha <srsinha@microsoft.com> * Add Registries 2023-04-01 Swagger (#23085) * add swagger + examples * fix readme * fix readme * switching to autogenerated registries swagger * fix spellcheck * update ga examples * previous API version for comparison = 2023-02-01-preview * new API version for comparison = 2023-04-01 * update examples * update swagger, examples to fix pr gates * fix lint diff errors * delete should have a 202 response, update createorupdate examples, fix removeRegions operation * removeRegions -> LRO POST operation * fix LRO options on removeRegions * add registryNameParamert * update swagger * update * PATCH property should have sku, identity properties * fix example --------- Co-authored-by: Komal Yadav <komalyadav@microsoft.com> * MFE April 2023 staging (#23164) * add latest mfe.json * updated examples * add wasbs to known words * swap pendingupload to proper naming * align RPs on Azure Machine Learning Services * rename pendingUpload to verb: startPendingUpload * remove trailing slash startpendingupload * improve descriptions * add pattern to all resource name types + examples * update original-uri -> azure-async-operation * remove wasbs and mark credential usage as secret * test is changing all to azure-async-operation causes breaking change * the code is implemented where the original-uri is where you will find the final object post-polling * update examples to remove wasbsUri * reference registries instead for RegistryName * remove wasbs * original-uri -> azure-async-operation * update examples to empty secrets * CreateOrUpdatePendingUpload -> CreateOrUpdateStartPendingUpload * add pattern for workspaceName * x-ms-secret on the SASUri * switch back to original-uri given update from auto-rest folks --------- Co-authored-by: Kayla Ames <kaseager@microsoft.com> * update compute examples to ReadOnly * v5->v3 * PartialManagedServiceIdentity -> RegistryPartialManagedServiceIdentity * update ID for delete/cancel job/schedule location header * PrivateEndpointConnection -> RegistryPrivateEndpointConnection * more renames for Registry * align mlc with arm * update registry examples * update registryPrivateLinkServiceConnectionState in examples * update description arm id for registryPrivateEndpointConnections * update to preview --------- Co-authored-by: Naman Agarwal <namanag16@gmail.com> Co-authored-by: Naman Agarwal <naagarw@microsoft.com> Co-authored-by: Teddy Todorov <thtodoro@microsoft.com> Co-authored-by: srivatsasinha <102133347+srivatsasinha@users.noreply.github.com> Co-authored-by: Srivatsa Sinha <srsinha@microsoft.com> Co-authored-by: Komal Yadav <23komal.yadav23@gmail.com> Co-authored-by: Komal Yadav <komalyadav@microsoft.com> Co-authored-by: Kayla Ames <kaseager@microsoft.com>
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…023 04 01 (Azure#23450) * Adds base for updating Microsoft.MachineLearningServices from version stable/2022-10-01 to version 2023-04-01 * Updates readme * Updates API version in new specs and examples * [Stable] Bring Back schedule shutdown MLC models (Azure#23039) * bring back schedule shutdown MLC models * add description --------- Co-authored-by: Naman Agarwal <naagarw@microsoft.com> * add minLength:1 prop to required strings (Azure#23109) * [Stable] Add IdleShutdown properties and api (Azure#23042) * [Stable] Add IdleShutdown properties and api * update version * remove api to update IdleShutdownSetting * Delete example --------- Co-authored-by: Naman Agarwal <naagarw@microsoft.com> * Pushing new features in stable swagger (Azure#23071) * Pushing new features in stable swagger * Added example file * Triggering retest * Fixed version issue * Triggering retest * Removing OS Patching * Changes as per feedback, and add os patching back * Fix formatting * Removed Custom Service Update API * Fixed Example Files * Added as per review comments * Added as per review comments * Retrigger test --------- Co-authored-by: Srivatsa Sinha <srsinha@microsoft.com> * Add Registries 2023-04-01 Swagger (Azure#23085) * add swagger + examples * fix readme * fix readme * switching to autogenerated registries swagger * fix spellcheck * update ga examples * previous API version for comparison = 2023-02-01-preview * new API version for comparison = 2023-04-01 * update examples * update swagger, examples to fix pr gates * fix lint diff errors * delete should have a 202 response, update createorupdate examples, fix removeRegions operation * removeRegions -> LRO POST operation * fix LRO options on removeRegions * add registryNameParamert * update swagger * update * PATCH property should have sku, identity properties * fix example --------- Co-authored-by: Komal Yadav <komalyadav@microsoft.com> * MFE April 2023 staging (Azure#23164) * add latest mfe.json * updated examples * add wasbs to known words * swap pendingupload to proper naming * align RPs on Azure Machine Learning Services * rename pendingUpload to verb: startPendingUpload * remove trailing slash startpendingupload * improve descriptions * add pattern to all resource name types + examples * update original-uri -> azure-async-operation * remove wasbs and mark credential usage as secret * test is changing all to azure-async-operation causes breaking change * the code is implemented where the original-uri is where you will find the final object post-polling * update examples to remove wasbsUri * reference registries instead for RegistryName * remove wasbs * original-uri -> azure-async-operation * update examples to empty secrets * CreateOrUpdatePendingUpload -> CreateOrUpdateStartPendingUpload * add pattern for workspaceName * x-ms-secret on the SASUri * switch back to original-uri given update from auto-rest folks --------- Co-authored-by: Kayla Ames <kaseager@microsoft.com> * update compute examples to ReadOnly * v5->v3 * PartialManagedServiceIdentity -> RegistryPartialManagedServiceIdentity * update ID for delete/cancel job/schedule location header * PrivateEndpointConnection -> RegistryPrivateEndpointConnection * more renames for Registry * align mlc with arm * update registry examples * update registryPrivateLinkServiceConnectionState in examples * update description arm id for registryPrivateEndpointConnections * update to preview --------- Co-authored-by: Naman Agarwal <namanag16@gmail.com> Co-authored-by: Naman Agarwal <naagarw@microsoft.com> Co-authored-by: Teddy Todorov <thtodoro@microsoft.com> Co-authored-by: srivatsasinha <102133347+srivatsasinha@users.noreply.github.com> Co-authored-by: Srivatsa Sinha <srsinha@microsoft.com> Co-authored-by: Komal Yadav <23komal.yadav23@gmail.com> Co-authored-by: Komal Yadav <komalyadav@microsoft.com> Co-authored-by: Kayla Ames <kaseager@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.