[Hub Generated] Review request for Microsoft.Workloads to add version preview/2022-11-01-preview #22207
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
…12-01-preview to version 2022-11-01-preview
Common - Removed PHP Resource Type files and swagger references (Azure/azure-rest-api-specs-pr#8858) - added security defination to commonTypes.json (Azure/azure-rest-api-specs-pr#8858) SapVirtualInstance - Added a new supported payload for sapVirtualInstance/PUT API, for detecting the SAP Software Installation (Azure/azure-rest-api-specs-pr#8991) - Added support for SAP Trans Fileshare configs (Azure/azure-rest-api-specs-pr#9200) - Added SAP SID as property for HANA provider (Azure/azure-rest-api-specs-pr#9462) - Added support for LB and storage details changes (Azure/azure-rest-api-specs-pr#9464) - Added DiskConfiguration Optional Property (Azure/azure-rest-api-specs-pr#9874) - Instance level start stop support for ASCS and App Instance (Azure/azure-rest-api-specs-pr#9105) - Instance level start stop support for DB Instance (Azure/azure-rest-api-specs-pr#9608) - Added endpoint to get the details about the last execution of a particular type of operation (Azure/azure-rest-api-specs-pr#9570) - Added vmDetails array to SapApplicationServerProperties (Azure/azure-rest-api-specs-pr#9873) - Modify Output Structure to add disk customization (Azure/azure-rest-api-specs-pr#10381) - Added resource name customization support (Azure/azure-rest-api-specs-pr#10550) Monitors - Added sapSid property in os, hana providers (Azure/azure-rest-api-specs-pr#9085) - Added support for secure communication (Azure/azure-rest-api-specs-pr#9081) - Adding new Endpoint for Storing SPOG Config (Azure/azure-rest-api-specs-pr#9366)
|
Hi, @gargankit-microsoft 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 |
|---|---|---|
| SAPVirtualInstance.json | 2022-11-01-preview(eb8c8d5) | 2021-12-01-preview(main) |
| commonTypes.json | 2022-11-01-preview(eb8c8d5) | 2021-12-01-preview(main) |
| monitors.json | 2022-11-01-preview(eb8c8d5) | 2021-12-01-preview(main) |
| operations.json | 2022-11-01-preview(eb8c8d5) | 2021-12-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 5 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(eb8c8d5) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SapLandscapeMonitorModel'. Consider using the plural form of 'SapLandscapeMonitor' 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.Workloads/preview/2022-11-01-preview/monitors.json#L579 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SapLandscapeMonitorModel'. Consider using the plural form of 'SapLandscapeMonitor' 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.Workloads/preview/2022-11-01-preview/monitors.json#L623 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SapLandscapeMonitorModel'. Consider using the plural form of 'SapLandscapeMonitor' 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.Workloads/preview/2022-11-01-preview/monitors.json#L673 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SapLandscapeMonitorModel'. Consider using the plural form of 'SapLandscapeMonitor' 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.Workloads/preview/2022-11-01-preview/monitors.json#L714 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SapLandscapeMonitorModel'. Consider using the plural form of 'SapLandscapeMonitor' 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.Workloads/preview/2022-11-01-preview/monitors.json#L760 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Workloads/preview/2022-11-01-preview/monitors.json#L855 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Workloads/preview/2022-11-01-preview/SAPVirtualInstance.json#L2199 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Workloads/preview/2022-11-01-preview/SAPVirtualInstance.json#L2337 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Workloads/preview/2022-11-01-preview/SAPVirtualInstance.json#L2559 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Workloads/preview/2022-11-01-preview/SAPVirtualInstance.json#L2563 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Workloads/preview/2022-11-01-preview/SAPVirtualInstance.json#L4231 |
️❌Avocado: 6 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Workloads/phpWorkloads is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/workloads/resource-manager/readme.md json: Microsoft.Workloads/preview/2021-12-01-preview/phpWorkloads.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Workloads/phpWorkloads is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/workloads/resource-manager/readme.md json: Microsoft.Workloads/preview/2021-12-01-preview/phpWorkloads.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Workloads/phpWorkloads/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/workloads/resource-manager/readme.md json: Microsoft.Workloads/preview/2021-12-01-preview/phpWorkloads.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Workloads/phpWorkloads/{}/wordpressInstances is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/workloads/resource-manager/readme.md json: Microsoft.Workloads/preview/2021-12-01-preview/phpWorkloads.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Workloads/phpWorkloads/{}/wordpressInstances/default is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/workloads/resource-manager/readme.md json: Microsoft.Workloads/preview/2021-12-01-preview/phpWorkloads.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Workloads/skus is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/workloads/resource-manager/readme.md json: Microsoft.Workloads/preview/2021-12-01-preview/skus.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @gargankit-microsoft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @gargankit-microsoft, 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. |
This was referenced Jan 17, 2023
This was referenced Jan 17, 2023
|
Hi, @NetRock, could you please help with 'ARMSignedOff' tag for this PR, like original PR. |
tadelesh
added
the
Approved-SdkBreakingChange-Go
raosuhas
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
raych1
added
Approved-OkToMerge
openapi-workflow-bot
bot
added
commitAfterSignedOff
and removed
Approved-OkToMerge
|
Hi @gargankit-microsoft, Your PR has some issues. Please fix the CI sequentially by following the order of
|
raych1
approved these changes
Jan 21, 2023
raych1
added
the
Approved-OkToMerge
…ame of the storage account that will be created as part of VIS registration.
openapi-workflow-bot
bot
removed
the
Approved-OkToMerge
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
raych1
deleted the
gargankit-microsoft-workloads-Microsoft.Workloads-2022-11-01-preview
branch
This was referenced Jan 31, 2023
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Jan 31, 2023
…rkloads to add version preview/2022-11-01-preview (#2764) Create to sync Azure/azure-rest-api-specs#22207 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/workloads?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.
Changes for v2022-11-01-preview. All individual PRs have ARM review and Breaking change signoffs before getting merged in Private repo. So, re-review should not be required.
Breaking change Explanation for removed properties: See this Comment
Avocado Explanation: See this Comment
Common
SapVirtualInstance
Monitors
PhpWorkloads
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.