Correct Schema for Virtual Machine Scaleset diskControllerType field #25628
Conversation
This file contains hidden or 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
Remove the items wrapper, which causes the field to be interpreted as an array. Remove the type field, to match other field shapes, and deconflict with the type field in the referenced schema.
Navigatron
requested review from
Sandido,
dkulkarni-ms,
haagha,
MS-syh2qs and
grizzlytheodore
as code owners
Next Steps to Merge
|
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| virtualMachineScaleSet.json | 2023-07-01(94cd306) | 2023-07-01(main) |
| Rule | Message |
|---|---|
|
The '$ref' property points to different models in the old and new versions. New: ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json#L4063:9 Old: ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json#L4063:9 |
|
The '$ref' property points to different models in the old and new versions. New: ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json#L4091:9 Old: ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json#L4094:9 |
|
The new version adds a x-ms-enum extension. New: ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json#L4063:9 Old: ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json#L4063:9 |
|
The new version adds a x-ms-enum extension. New: ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json#L4091:9 Old: ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json#L4094:9 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.4) | new version | base version |
|---|---|---|
| package-2023-07-01 | package-2023-07-01(94cd306) | package-2023-07-01(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Based on the response model schema, operation 'VirtualMachineScaleSetVMExtensions_List' might be pageable. Consider adding the x-ms-pageable extension. Location: ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json#L2457 |
️⚠️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-2023-07-01 |
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView 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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
microsoft-github-policy-service
bot
added
the
customer-reported
|
Thank you for your contribution Navigatron! We will review the pull request and get back to you soon. |
AzureRestAPISpecReview
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
This was referenced Sep 1, 2023
1017: Reference RedirectionThe Old
This is not accurate to what the API actually returns. NewThis PR changes 1048: AddedXmsEnumSince SummaryThis PR changes I hope this is clear - if there is anything else I can elaborate on; I would be happy to. Thanks! |
|
I do not have access to the breaking change process documentation, the specreview teams channel, or the ability to remove tags from this PR. @rkmanda Could you please remove the |
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.
The Virtual Machine Scaleset diskControllerType field is defined as:
And references this definition:
The presence of the
itemsfield causesdiskControllerTypeto be treated as an array, where elements must be strings of the above enum. This PR elevates thedescriptionand$reffields out ofitems, so thatdiskControllerTypeis correctly interpreted as astring.Additionally, I removed the
typefield, as this is provided by the$ref, and follows the precedent set by other nearby fields that use a$refto set theirtype.This PR fixes #25202 and pulumi azure-native #2639
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.