[Hub Generated] Review request for Microsoft.MachineLearningServices to add version preview/2022-06-01-preview #19842
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
… stable/2022-05-01 to version 2022-06-01-preview
* Added idleTimeBeforeShutdown to compute instance properties * Added api UpdateIdleShutdownSetting Co-authored-by: Teo Magnino Chaban <[email protected]>
* update mfe.json with 2022-06-01-preview spec * update go.md with preview-2022-06 * add AutoMLJob examples (initial) * add LabelingJob examples (initial) * add Schedule examples (initial) * prettier * update AutoMLJob examples * update LabelingJob examples * update LabelingJob examples * prettier * typo fixes * add Vectorizer to custom-words.txt * add missing * is this a breaking change? * Revert "update go.md with preview-2022-06" This reverts commit b49c64a.
|
Hi, @erjms 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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| machineLearningServices.json | 2022-06-01-preview(39ebcde) | 2022-05-01(main) |
| machineLearningServices.json | 2022-06-01-preview(39ebcde) | 2022-02-01-preview(main) |
| mfe.json | 2022-06-01-preview(39ebcde) | 2022-05-01(main) |
| mfe.json | 2022-06-01-preview(39ebcde) | 2022-02-01-preview(main) |
| workspaceFeatures.json | 2022-06-01-preview(39ebcde) | 2022-05-01(main) |
| workspaceFeatures.json | 2022-06-01-preview(39ebcde) | 2022-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
Only 16 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 4 Errors, 76 Warnings failed [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-06 | package-preview-2022-06(39ebcde) | default(main) |
The following errors/warnings are introduced by current PR:
Only 16 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L11503 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L11521 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L13613 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L14431 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L11612 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L13716 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1010 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ComputeModel'. Consider using the plural form of 'Compute' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1333 |
|
| The child tracked resource, 'labelingJobs' with immediate parent 'Workspace', must have a list by immediate parent operation. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L11600 |
|
| The child tracked resource, 'schedules' with immediate parent 'Workspace', must have a list by immediate parent operation. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L13704 |
|
| Guid used in model definition 'LabelingJob' for property 'projectId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L11508 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: privileged Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L4952 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: readOnly Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L5019 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nocopy Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L5057 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: createHostPath Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L5072 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: scheduled Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L3311 |
The following errors/warnings exist before current PR submission:
Only 16 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L6725 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L6811 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L8963 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L10681 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L12407 |
|
When property is modeled as 'readOnly': true then x-ms-mutability extension can only have 'read' value. When property is modeled as 'readOnly': false then applying x-ms-mutability extension with only 'read' value is not allowed. Extension contains invalid values: 'read'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L12507 |
|
Collection object 'AmlComputeNodesInformation' returned by list operation 'Compute_ListNodes' with 'x-ms-pageable' extension, has no property named 'value'. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L1086 |
| Since operation 'QuotasUpdate' response has model definition 'array', it should be of the form 'list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L567 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3263 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3364 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3459 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3672 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3861 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3882 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3950 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/machineLearningServices.json#L3993 |
️❌Avocado: 6 Errors, 1 Warnings failed [Detail]
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌ModelValidation: 10 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/39ebcde4bca26dc856705e6b892c7a7f0d22aea8/specification/machinelearningservices/resource-manager/readme.md#tag-package-preview-2022-06">machinelearningservices/resource-manager/readme.md#package-preview-2022-06
| Rule | Message |
|---|---|
| "readme":"machinelearningservices/resource-manager/readme.md", "tag":"package-preview-2022-06", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
|
Hi @erjms, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Jul 19, 2022
* Updating Swagger Spec for MLC for CustomServices * Added Examples * Removing update API in favor of exisiting Patch API and Fixing some Validation issues * Fixed Pretty Issue * Fixed Id Issue * Changed case * Updated Examples * Changing Description * Added nullable fields * Added update APIs * Fixing validation errors * Fix model validation Co-authored-by: Srivatsa Sinha <[email protected]>
* Add encryption property to workspace update parameters Adding the ability for users to update CMK keyIdentifier property for workspace update. * Apply prettier changes Co-authored-by: Joshua Loeffler <[email protected]>
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @erjms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
* add soft delete related properties * resolve lint diff issue that enum name duplicaton Co-authored-by: Xi Jin <[email protected]>
erjms
added
the
DoNotMerge
@raosuhas Given our tight timeline for this API and the fact that our GA stable version does not use ODATA for filter queries, could we keep the PR as-is for this preview version and look into implementing ODATA for future preview/GA versions? Above all, we would like to avoid breaking changes and schedule risk given the complexities of modifying the underlying service to accommodate this change. Also FYI - these files already were reviewed and given ARM signoff via various PRs into this staging branch, please see my reply here: |
@raosuhas These features are in preview and their contracts have not solidified. Similar to my above response, could we keep them as-is in this PR, and look into updating them to enums in the next preview or GA version? |
erjms
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Suppress LintDiff and ModelValidation because they are all known false alarms |
tadelesh
added
the
Approved-SdkBreakingChange-Go
raosuhas
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
ArcturusZhang
approved these changes
Aug 5, 2022
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
ArcturusZhang
deleted the
dev-machinelearningservices-Microsoft.MachineLearningServices-2022-06-01-preview
branch
This was referenced Aug 5, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Aug 5, 2022
…r Microsoft.MachineLearningServices to add version preview/2022-06-01-preview (#2513) Create to sync Azure/azure-rest-api-specs#19842 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/machinelearningservices?expand=1)
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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.