Add Dec API Registries Swagger #21419
Merged
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, @komo23x 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.1)] | new version | base version |
|---|---|---|
| registries.json | 2022-12-01-preview(16308e6) | 2022-10-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️⚠️LintDiff: 3 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-12 | package-preview-2022-12(16308e6) | package-preview-2022-12(machinelearningservices-Microsoft.MachineLearningServices-2022-12-01-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| The operation 'Registries_Update' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L232 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowBlobPublicAccess Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L834 |
||
| 'allowBlobPublicAccess' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L834 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L440 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L606 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L644 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: storageAccountHnsEnabled Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L826 |
|
| The tracked resource, 'RegistryTrackedResource', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L586 |
|
| 'PartialUserAssignedIdentity' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L477 |
|
| 'publicNetworkAccess' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L518 |
|
| 'discoveryUrl' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L522 |
|
| 'intellectualPropertyPublisher' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L526 |
|
| 'mlFlowRegistryUri' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L535 |
|
| 'privateLinkCount' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L539 |
|
| 'RegistryTrackedResource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L586 |
|
| 'ResourceBase' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L636 |
|
| 'SystemCreatedAcrAccount' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L803 |
|
| 'acrAccountSku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L806 |
|
| 'SystemCreatedStorageAccount' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L818 |
|
| 'storageAccountHnsEnabled' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L826 |
|
| 'UserCreatedAcrAccount' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L840 |
|
| 'UserCreatedStorageAccount' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L851 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️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
|
This was referenced Nov 3, 2022
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @komo23x your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
NetRock
approved these changes
Nov 3, 2022
NetRock
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
ArcturusZhang
approved these changes
Nov 4, 2022
|
The reported breaking changes in SDKs are not introduced by this PR |
ArcturusZhang
merged commit c2fd484
into
Azure:machinelearningservices-Microsoft.MachineLearningServices-2022-12-01-preview
fahdkmsft
reviewed
Nov 4, 2022
| @@ -534,6 +585,7 @@ | |||
| }, | |||
| "RegistryTrackedResource": { | |||
| "required": [ | |||
| "location", | |||
There was a problem hiding this comment.
Don't think we need to add location here if the base class TrackedResource already has it as a required property.
There was a problem hiding this comment.
Yes this needs to be removed. This is a breaking change that causes RegistryTrackedResource objects to be un-creatable, because the required location field is never passed down to TrackedResource if it's a named field of a child object.
|
I can't comment on unmodified code, but the registry/registryproperties object needs the managedResourceGroupTags field added, as specified by bullet 5 in the comment of this task: https://dev.azure.com/msdata/Vienna/_workitems/edit/2036303/ |
|
I would recommend running a diff between the registries.json and the same file located here: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ml/azure-ai-ml/swagger/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2022-10-01-preview/registries.json All differences in that file compared to the "original" registries.json are needed for the swagger to function properly. Make sure they're included. |
ArcturusZhang
pushed a commit
that referenced
this pull request
Feb 1, 2023
…1 preview (#21761) * Adds base for updating Microsoft.MachineLearningServices from version preview/2022-10-01-preview to version 2022-12-01-preview * Updates readme * Updates API version in new specs and examples * Add Dec API Registries Swagger (#21419) * add december registries swagger + examples * add status code 202 in examples * fix 202 examples * fixes * fixes * fix * add 202 back in for put/patch Co-authored-by: Komal Yadav <komalyadav@microsoft.com> * remove location (#21430) Co-authored-by: Komal Yadav <komalyadav@microsoft.com> * remove readonly flag on schedules property for CI (#21653) Co-authored-by: Naman Agarwal <naagarw@microsoft.com> * add missing workspace properties (#21725) * December preview updating mfe.json specs (#21510) * December preview updating mfe.json specs * MFE Dec 2022 Preview API - Adding logbase * MFE 2022-12-01-preview swagger spec model validation fix * MFE 2022-12-01-preview swagger spec model validation fix, add missing location * MFE 2022-12-01-preview swagger spec model validation - typo fix * MFE 2022-12-01-preview swagger spec model validation - fix api version in automljob example * MFE 2022-12-01-preview swagger spec model validation - fix for multiselectenabled error * MFE 2022-12-01-preview swagger spec model validation - fix for multiselectenabled error * Fix for 1006 - RemovedDefinition (RecurrenceTrigger,CronTrigger) (#21822) * fix ReadonlyPropertyChanged of MLC (#21814) Co-authored-by: Bingchen Li <bingchenli@microsoft.com> * fixed custom-words conflict (#21829) * fix custom-words conflict merge (#21830) * example fix (INVALID_REQUEST_PARAMETER) (#21832) Co-authored-by: Ivaliy Ivanov <ivaliyivanov@Ivaliys-MacBook-Air.local> * example fix, use correct api preview version - (INVALID_REQUEST_PARAMETER) (#21833) Co-authored-by: Ivaliy Ivanov <ivaliyivanov@Ivaliys-MacBook-Air.local> * Revert breaking change for MLC swagger 2022-12-01-preview (#21885) Co-authored-by: Bingchen Li <bingchenli@microsoft.com> * Revert Connection Category back to enum. (#21939) * revert provisioning state change (#21940) * remove body (#21978) Co-authored-by: Komal Yadav <komalyadav@microsoft.com> * Addressed comments, added x-ms-long-running-operation to a patch call (#22005) * Addressed comments, added x-ms-long-running-operation to a patch call * fix examples for patch - remove body * fixed formatting * Ivalbert fix patch2 (#22006) * Addressed comments, added x-ms-long-running-operation to a patch call * fix examples for patch - remove body * fixed formatting * fixed formatting * Updated custom words (#22262) * Fixed prettier errors (#22237) * fixed examples for LRO_RESPONSE_HEADER check (#22293) * fixed examples for LRO_RESPONSE_HEADER check (#22294) * Example fix - OBJECT_MISSING_REQUIRED_PROPERTY - Missing required property: triggerType (#22317) --------- Co-authored-by: Komal Yadav <23komal.yadav23@gmail.com> Co-authored-by: Komal Yadav <komalyadav@microsoft.com> Co-authored-by: Naman Agarwal <namanag16@gmail.com> Co-authored-by: Naman Agarwal <naagarw@microsoft.com> Co-authored-by: ZhidaLiu <zhili@microsoft.com> Co-authored-by: libc16 <88697960+libc16@users.noreply.github.com> Co-authored-by: Bingchen Li <bingchenli@microsoft.com> Co-authored-by: Ivaliy Ivanov <ivaliyivanov@Ivaliys-MacBook-Air.local>
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.