Adding VMAgentVersioning property#20097
Adding VMAgentVersioning property#20097grizzlytheodore merged 4 commits intoAzure:feature/cplat-2022-08-01from kamusta-msft:dev/kamusta/vmAgentVersioning
Conversation
|
Hi, @kamusta-msft 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.9.7)] | new version | base version |
|---|---|---|
| computeRPCommon.json | 2022-08-01(5c07448) | 2022-03-01(main) |
| virtualMachine.json | 2022-08-01(5c07448) | 2022-03-01(main) |
| virtualMachineScaleSet.json | 2022-08-01(5c07448) | 2022-03-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
️⚠️LintDiff: 2 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-08-01 | package-2022-08-01(5c07448) | package-2022-08-01(feature/cplat-2022-08-01) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableVMAgentPlatformUpdates Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L1268 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableVMAgentPlatformUpdates Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L1321 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: ComputeRP/stable/2022-08-01/virtualMachineScaleSet.json#L1908 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: ComputeRP/stable/2022-08-01/virtualMachineScaleSet.json#L5653 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Compute/operations' does not match the ARM specification. Please standardize the schema. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L37 |
R4037 - MissingTypeObject |
The schema 'ComputeOperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L178 |
R4037 - MissingTypeObject |
The schema 'ComputeOperationValue' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L194 |
R4037 - MissingTypeObject |
The schema 'ComputeOperationValueDisplay' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L213 |
R4037 - MissingTypeObject |
The schema 'UsageName' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L238 |
R4037 - MissingTypeObject |
The schema 'Usage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L251 |
R4037 - MissingTypeObject |
The schema 'ListUsagesResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L287 |
R4037 - MissingTypeObject |
The schema 'InstanceViewStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L319 |
R4037 - MissingTypeObject |
The schema 'InstanceViewStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L319 |
R4037 - MissingTypeObject |
The schema 'InstanceViewStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L319 |
R4037 - MissingTypeObject |
The schema 'InstanceViewStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L319 |
R4037 - MissingTypeObject |
The schema 'InstanceViewStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L319 |
R4037 - MissingTypeObject |
The schema 'InstanceViewStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L319 |
R4037 - MissingTypeObject |
The schema 'InstanceViewStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L319 |
R4037 - MissingTypeObject |
The schema 'InstanceViewStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L319 |
R4037 - MissingTypeObject |
The schema 'InstanceViewStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L319 |
R4037 - MissingTypeObject |
The schema 'SubResourceWithColocationStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L354 |
R4037 - MissingTypeObject |
The schema 'SubResourceWithColocationStatus' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L354 |
R4037 - MissingTypeObject |
The schema 'VirtualMachineSize' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L367 |
R4037 - MissingTypeObject |
The schema 'VirtualMachineSize' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L367 |
R4037 - MissingTypeObject |
The schema 'VirtualMachineSize' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L367 |
R4037 - MissingTypeObject |
The schema 'VirtualMachineSizeListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L401 |
R4037 - MissingTypeObject |
The schema 'VirtualMachineSizeListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L401 |
R4037 - MissingTypeObject |
The schema 'VirtualMachineSizeListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L401 |
R4037 - MissingTypeObject |
The schema 'Plan' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L416 |
R4037 - MissingTypeObject |
The schema 'Plan' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L416 |
R4037 - MissingTypeObject |
The schema 'Plan' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L416 |
R4037 - MissingTypeObject |
The schema 'HardwareProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2022-08-01/computeRPCommon.json#L437 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2022-08-01 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌SDK Track2 Validation: 1 Errors, 0 Warnings failed [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/5c0744848dc4f09ff3fa1c9a82c599d2e098be67/specification/compute/resource-manager/readme.md#tag-package-2022-08-01">compute/resource-manager/readme.md#package-2022-08-01
- "https://github.com/Azure/azure-rest-api-specs/blob/5c0744848dc4f09ff3fa1c9a82c599d2e098be67/specification/compute/resource-manager/readme.md#tag-package-2022-08-01-only">compute/resource-manager/readme.md#package-2022-08-01-only
| Rule | Message |
|---|---|
PreCheck/DuplicateSchema |
"readme":"compute/resource-manager/readme.md", "tag":"package-2022-08-01", "details":"Duplicate Schema named 'PurchasePlan' (1 differences):\n - properties.promotionCode: => "$ref":"#/components/schemas/schemas:1397", "description":"The Offer Promotion Code."; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2022-08-01", "details":"Error: 1 errors occured -- cannot continue." |
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-08-01-only", "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
|
Generated ApiView
|
|
Hi @kamusta-msft, Your PR has some issues. Please fix the CI sequentially by following the order of
|
| }, | ||
| "protectedSettingsFromKeyVault": { | ||
| "type": "object", | ||
| "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference", |
There was a problem hiding this comment.
was this a mistake in the previous version? this will be considered breaking change.
will you comment on why this change is being made / justification for breaking change
There was a problem hiding this comment.
yes, it was a mistake in the previous version. That's being addressed here: #20101. It should also get fixed here to avoid confusion
|
Hi, @kamusta-msft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
@kamusta-msft since a breaking change, will you comment justification/reason for breaking change and then tag @ JeffreyRichter to get approval? |
|
Hi @kamusta-msft, 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. |
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.