Fix compute model validation errors #22271
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
added 6 commits
January 20, 2023 17:26
grizzlytheodore
requested review from
Sandido,
dkulkarni-ms,
haagha,
madewithsmiles,
MS-syh2qs and
hyonholee
as code owners
|
Hi, @grizzlytheodore 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 |
|---|---|---|
| availabilitySet.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| capacityReservation.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| computeRPCommon.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| dedicatedHost.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| image.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| restorePoint.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| sshPublicKey.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| virtualMachine.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| virtualMachineExtensionImage.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| virtualMachineImage.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| virtualMachineScaleSet.json | 2022-11-01(3badca6) | 2022-11-01(main) |
| common.json | 1.0(3badca6) | 1.0(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️⚠️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-11-01 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️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
|
ghost
added
the
grizzlytheodore
added
the
DoNotMerge
This was referenced Jan 20, 2023
ArcturusZhang
added
Approved-ModelValidation
and removed
DoNotMerge
tadelesh
added
the
Approved-SdkBreakingChange-Go
openapi-pipeline-app
bot
added
the
DoNotMerge
ArcturusZhang
removed
the
DoNotMerge
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
openapi-pipeline-app
bot
added
DoNotMerge
|
Offline talked with the author, the PR is good to merge now |
This was referenced Mar 1, 2023
This was referenced Mar 1, 2023
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
* remove instance view from virtualmachine list * remove instance view from vm list * add id to availability set object in examples * add id for dedicated host * add id for ssh key in examples * add id for capacity reservation in examples * LRO_Response_Header for examples * fix all the example titles to be singular * make example titles also singular * add vmss id in vmss get/list * add vmExtensionImage ids to examples * add VMExtension id to examples * add id for managed disks * Revert "add id for managed disks" This reverts commit adbeabb. * fix example name error * point managed disk to SubResourceIdNotRequired * remove instance view from virtualmachine list * update Swagger files to resolve model validations * fix examples * change "header" to "headers" in examples * fix examples. * fix LIntDiffs * add schema description * try suppressing lintDiff * revert last commit * lintdiff suppress * try * try * updated * fix * try * try * try * remove R2062 * suppress XmsResourceInPutResponse * remove x-ms-azure-resource tag from SubResource, SubResourceReadOnly and add it to objects referring to them instead. * remove x-ms-azure-resource from virtualMachineImage because it is not a tracked resource * fix generation error * mitigate track 1 generating issue --------- Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com>
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.
ARM API Information (Control Plane)
98% of this PR is updating examples to address modelvalidations and updating example names to be consistent.
We had to update swagger object property to correctly reflect objects that do not return IDs.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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.