[Hub Generated] Review request for Microsoft.HybridCompute to add version preview/2022-05-10-preview #19099
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
…22-03-10 to version 2022-05-10-preview
|
Hi, @dorothyhu 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 tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-05 | package-preview-2022-05(12419e2) | default(main) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAutomaticUpgrade Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1320 |
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.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1138 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1172 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1220 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1240 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L726 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L865 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L927 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L1002 |
|
| Based on the response model schema, operation 'PrivateLinkScopes_GetValidationDetails' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L591 |
|
| Based on the response model schema, operation 'PrivateLinkScopes_GetValidationDetailsForMachine' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L630 |
|
| The child tracked resource, 'extensions' with immediate parent 'Machine', must have a list by immediate parent operation. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1217 |
|
| The child tracked resource, 'privateLinkResources' with immediate parent 'HybridComputePrivateLinkScope', must have a list by immediate parent operation. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L861 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'HybridComputePrivateLinkScope', must have a list by immediate parent operation. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L993 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L746 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAutomaticUpgrade Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1271 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoUpgradeMinorVersion Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1275 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoUpgradeMinorVersion Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L1324 |
|
| 'parameters' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L460 |
|
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L5 |
|
| 'PrivateLinkScopeValidationDetails' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L743 |
|
| 'ConnectionDetail' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L764 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List Machines by resource group Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L318 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or Update a Machine Extension Location: Microsoft.HybridCompute/preview/2022-05-10-preview/HybridCompute.json#L450 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Gets private endpoint connection. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L379 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Gets private endpoint connection. Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L428 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: PrivateLinkScopeGet Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L622 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: PrivateLinkScopeGet Location: Microsoft.HybridCompute/preview/2022-05-10-preview/privateLinkScopes.json#L661 |
️❌Avocado: 3 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: specification/hybridcompute/resource-manager/readme.md json: Microsoft.HybridCompute/preview/2019-08-02/HybridCompute.json |
|
The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: specification/hybridcompute/resource-manager/readme.md json: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json |
|
The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: specification/hybridcompute/resource-manager/readme.md json: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️🔄ModelValidation inProgress [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 4 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Using directive.0.suppress which is deprecated and will be removed in the future." |
|
| "readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ExtensionTargetProperties > properties > targetVersion)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > ExtensionTarget > additionalProperties)\n keys: [ \u001b[32m'type'\u001b[39m ]" |
|
| "readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Semantic violation: Extension 'x-ms-code-generation-settings' is not supported in Autorest V3. It will just be ignored. (info > x-ms-code-generation-settings)" |
|
| 💬 | "readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"AutoRest core version selected from configuration: ^3.2.0." |
| 💬 | "readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)" |
| 💬 | "readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)" |
| 💬 | "readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)" |
| 💬 | "readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)" |
| 💬 | "readme":"hybridcompute/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Autorest completed in 14.78s. 0 files generated." |
️️✔️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 @dorothyhu, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced May 17, 2022
This was referenced May 17, 2022
|
Hi @xiaoxuqi-ms, I am not sure why it is complaining about the error below, but the operations_list was never removed from the spec or the example |
|
Also Linter complained about the "additionalProperties: true" in our swagger. This line is suggested by the Az Powershell folks to fix our problem in generating PowerShell module and is it not allowed here. Why does it have a discrepancy between ARM and Az Powershell |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
mikekistler
added
the
Approved-BreakingChange
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
xiaoxuqi-ms
approved these changes
Jun 29, 2022
|
@dorothyhu , as discussed offline, once your service ready, I will merge this pr. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced Jul 8, 2022
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.