Compute Gallery RP 2022-01-03 Release #18976
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
setup feature branch and update common.json Update gallery.json fix mistake made in example name readme and python readme from main sync main sync common.json optional location
* save * update * update * update * update * update * update * nit * 'save' * add * update * add architecture * update * update * Update readme add `package-2022-01-03-only` tag for python * save * nit Co-authored-by: Jiefeng Chen <51037443+BigCat20196@users.noreply.github.com>
* update * update * update * update * update * update
…8722) * adds settings and advancedSettings to gallery application version * fix spell checker and LintDiff * added description and ran prettifier again * fix typo in description * Addressed PR comments * updated description to use full name of the VMApp extension, i.e. vm-application-manager
|
Hi, @Sandido 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
|
| Rule | Message |
|---|---|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: stable/2022-01-03/GalleryRP/galleryRPCommon.json#L212 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: excludeFromLatest Location: stable/2022-01-03/GalleryRP/communityGallery.json#L475 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: excludeFromLatest Location: stable/2022-01-03/GalleryRP/sharedGallery.json#L612 |
|
| 'SubResourceReadOnly' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Compute/stable/2022-01-03/common.json#L153 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get a community gallery. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L72 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L38 |
|
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L38 |
|
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L38 |
|
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L38 |
|
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L55 |
|
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L55 |
|
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L55 |
|
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L55 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L68 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L68 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L68 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L68 |
|
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L77 |
|
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L77 |
|
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L77 |
|
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L77 |
|
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L109 |
|
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L109 |
|
The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L144 |
|
The schema 'SubResourceReadOnly' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L153 |
|
The schema 'ExtendedLocation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L207 |
|
The schema 'PirCommunityGalleryResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L267 |
|
The schema 'CommunityGalleryIdentifier' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L291 |
|
The schema 'CommunityGallery' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L300 |
|
The schema 'CommunityGalleryImage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L330 |
|
The schema 'CommunityGalleryImageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L344 |
|
The schema 'CommunityGalleryImageVersion' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L449 |
|
The schema 'CommunityGalleryImageVersionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L463 |
|
The schema 'Gallery' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L1735 |
|
The schema 'GalleryUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L1749 |
️⚠️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-01-03 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 1 Errors, 3 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.5)
- current:2022-01-03/GalleryRP/communityGallery.json compared with base:stable/2021-07-01/communityGallery.json
- current:2022-01-03/GalleryRP/gallery.json compared with base:stable/2021-10-01/gallery.json
- current:2022-01-03/GalleryRP/gallery.json compared with base:preview/2020-09-30/gallery.json
- current:2022-01-03/GalleryRP/sharedGallery.json compared with base:stable/2021-07-01/sharedGallery.json
- current:2022-01-03/GalleryRP/sharedGallery.json compared with base:preview/2020-09-30/sharedGallery.json
| Rule | Message |
|---|---|
|
The new version is removing enum value(s) 'Community' from the old version. New: stable/2022-01-03/GalleryRP/gallery.json#L1835:9 Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L1844:9 |
The following breaking changes are detected by comparison with latest preview version:
| Rule | Message |
|---|---|
| The new version is missing a client parameter that was found in the old version. Was 'LocationNameParamter' removed or renamed? New: azure-rest-api-specs/blob/4380ea525d620b06b9145d3fe255391f2ab27d91/revision:1024:2 Old: Microsoft.Compute/preview/2020-09-30/sharedGallery.json#L762:3 |
|
| The new version has a different type 'object' than the previous one ''. New: stable/2022-01-03/GalleryRP/gallery.json#L2493:9 Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2358:9 |
|
| The new version has a different type 'object' than the previous one ''. New: stable/2022-01-03/GalleryRP/gallery.json#L2509:5 Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2371:5 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @Sandido your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
25 tasks
This was referenced May 9, 2022
Sandido
requested review from
msyyc,
BigCat20196,
dkulkarni-ms,
haagha,
madewithsmiles and
MS-syh2qs
as code owners
|
Trying to get ARM to review this: https://portal.microsofticm.com/imp/v3/incidents/details/307135457/home |
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
ArcturusZhang
approved these changes
May 17, 2022
Comment on lines
+238
to
+266
| ### Tag: package-2022-01-03 | ||
|
|
||
| These settings apply only when `--tag=package-2022-01-03` is specified on the command line. | ||
|
|
||
| ``` yaml $(tag) == 'package-2022-01-03' | ||
| input-file: | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/computeRPCommon.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/virtualMachineScaleSet.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/virtualMachine.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/virtualMachineImage.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/virtualMachineExtensionImage.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/availabilitySet.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/proximityPlacementGroup.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/dedicatedHost.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/sshPublicKey.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/image.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/restorePoint.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/capacityReservation.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/logAnalytic.json | ||
| - Microsoft.Compute/stable/2022-03-01/ComputeRP/runCommand.json | ||
| - Microsoft.Compute/stable/2021-07-01/skus.json | ||
| - Microsoft.Compute/stable/2021-12-01/disk.json | ||
| - Microsoft.Compute/stable/2022-01-03/common.json | ||
| - Microsoft.Compute/stable/2022-01-03/GalleryRP/galleryRPCommon.json | ||
| - Microsoft.Compute/stable/2022-01-03/GalleryRP/gallery.json | ||
| - Microsoft.Compute/stable/2022-01-03/GalleryRP/sharedGallery.json | ||
| - Microsoft.Compute/stable/2022-01-03/GalleryRP/communityGallery.json | ||
| - Microsoft.Compute/stable/2021-03-01/cloudService.json | ||
| ``` |
There was a problem hiding this comment.
Adding this tag which is definitely newer than package-2022-03-01, but considering its name, it gives us an illusion that this is older than package-2022-03-01.
Could we just replace the old gallery with the new ones introduced by this PR in package-2022-03-01 and remove this tag to avoid this?
There was a problem hiding this comment.
If no SDKs have been released with 2022-03-01, then yes we can do that. I know we haven't requested any SDK releases.
There was a problem hiding this comment.
@ArcturusZhang , Another issue would be that the 2022-03-01-only tag would have to do 1 of the following:
- Include the references to 2022-01-03 files, breaking the promise of just having the 2022-03-01 files.
- Not include the 2022-01-03 files in any -only tags, meaning there will be no way to get the 01-03-only files.
There was a problem hiding this comment.
So I am reticent in updating 2022-03-01.
There was a problem hiding this comment.
@ArcturusZhang , and we have now already generated SDKs on the 2022-03-01 version, so we now cannot edit 2022-03-01 tags.
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 PR is merging in all changes for the Gallery 2022-01-03 API version.
The Swagger PRs (and related .Net SDK PRs) that were merged to this release branch are:
Settings and Advanced Settings feature Swagger PR: https://github.com/Azure/azure-rest-api-specs/pull/18722/files
This PR was also approved by the ARM team.
.Net PR = SDK changes for new properties "settings" and "advancedSettings" to gallery application version azure-sdk-for-net#28250
Community and Shared Gallery features Swagger PR = gallery 01-03 release #17985
.Net PR = Gallery 01 03 SDK azure-sdk-for-net#27466
Privacy Statement Swagger PR = Add privacyStatement/Uri to communtiy gallery image #18680
.Net PR = add eula/privacy statement to gallery SDK release azure-sdk-for-net#28238
The breaking change has already been approved (as per the original PR here) and is expected. The breaking change is a removal of an enum value, and reviewed previously here.
The common.json file in this PR is slightly different than in the previous Gallery PR. This is due to the recent merge of the Compute RP version 2022-03-01 that added to the common.json file. These changes have been incorporated in this PRs common.json file to keep it up to date with main.
Apologies for the confusion. To ensure the feature branch abided by the ARM commit format, new branches and PRs were made. This is a new PR based on this PR: #18172 where I cherry picked the commits into this new branch. We had issues trying to use the OpenAPI tool to create a branch that fits the ARM format.
The individual SDK breaking changes are seen from previous work in the swagger branch, not this release.
The Javascript, and Python SDK teams signed off on their breaking changes in this previous PR already.
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 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 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.