Add mfe.json 2022-06-01-preview changes #19740
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, @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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| mfe.json | 2022-06-01(e6f622d) | 2022-05-01(main) |
| mfe.json | 2022-06-01(e6f622d) | 2022-02-01(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 21 items are listed, please refer to log for more details.
️❌LintDiff: 4 Errors, 60 Warnings failed [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-06 | package-preview-2022-06(e6f622d) | package-preview-2022-06(dev-machinelearningservices-Microsoft.MachineLearningServices-2022-06-01-preview) |
The following errors/warnings are introduced by current PR:
Only 21 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#L13609 |
|
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#L14427 |
| 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#L13712 |
|
| 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#L13700 |
|
| 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: scheduled Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L3311 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: includeJobInstructions Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L3775 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: includeLabelCategories Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L3782 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: amsGradient Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L10090 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: distributed Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L10129 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: earlyStopping Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L10134 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableOnnxNormalization Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L10151 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nesterov Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L10196 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: multiScale Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L10349 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: multiSelectEnabled Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L11360 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: incrementalDataRefreshEnabled Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L11416 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L13595 |
The following errors/warnings exist before current PR submission:
Only 21 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#L8954 |
|
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#L10672 |
|
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 |
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L6763 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L6851 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L7421 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L7478 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L7680 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L7749 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L8094 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L8223 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L8367 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L8718 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L8755 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L8878 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L9000 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L10692 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.MachineLearningServices/preview/2022-06-01-preview/mfe.json#L11023 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 10 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/e6f622d987cf3fbdecba3acd4dcc05aff1778f45/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.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
| Rule | Message |
|---|
️⚠️SDK Breaking Change Tracking warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-sdk-for-python-track2 warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-sdk-for-js warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-resource-manager-schemas warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-powershell failed [Detail]
Only 0 items are rendered, please refer to log for more details.
|
Hi @forteddyt, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @forteddyt your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
This was referenced Jul 12, 2022
This reverts commit b49c64a.
mentat9
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
ArcturusZhang
approved these changes
Jul 14, 2022
|
Adding Approved-LintDiff because the reported errors are false alarms and known issues |
raych1
reviewed
Jul 14, 2022
| "create", | ||
| "update" | ||
| ], | ||
| "x-ms-secret": true |
There was a problem hiding this comment.
x-ms-secret should put within the model of $ref, otherwise it won't work.
There was a problem hiding this comment.
that... seems sort of weird. the documentation of x-ms-secret (https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-secret) states that it's that "extension is used to annotate the secret property". is this a new rule? our previous API versions (including our GA API versions) have been handling secrets the way this PR has been handling them
additionally, our intention is also to have the entire object be treated as secret. we want to omit the secrets property altogether from responses, not respond back with {} (which is what marking each underlying property would do)
There was a problem hiding this comment.
x-ms-secret works on property level instead of object model level.
raych1
reviewed
Jul 14, 2022
| "key": { | ||
| "description": "Storage account key.", | ||
| "type": "string", | ||
| "x-nullable": true |
There was a problem hiding this comment.
x-ms-secret: true should be added for key property.
|
@forteddyt , as the change of x-ms-secret could bring breaking changes. So, work item was created to follow the correct usage of x-ms-secret on property level for future versions. I approved |
ArcturusZhang
merged commit 99844b1
into
Azure:dev-machinelearningservices-Microsoft.MachineLearningServices-2022-06-01-preview
11 tasks
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.