-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
gallery 01-03 release #17985
gallery 01-03 release #17985
Conversation
Swagger Validation Report
|
Rule | Message |
---|---|
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#L467 |
|
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 |
|
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 |
---|---|
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: stable/2022-01-03/GalleryRP/gallery.json#L1772 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: stable/2022-01-03/GalleryRP/gallery.json#L2069 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: stable/2022-01-03/GalleryRP/gallery.json#L2251 |
R2018 - XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: stable/2022-01-03/GalleryRP/gallery.json#L2319 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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#L441 |
R4037 - MissingTypeObject |
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#L455 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
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 |
R4037 - MissingTypeObject |
The schema 'GalleryProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L1763 |
R4037 - MissingTypeObject |
The schema 'GalleryIdentifier' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L1799 |
R4037 - MissingTypeObject |
The schema 'SharingProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L1809 |
R4037 - MissingTypeObject |
The schema 'SharingProfileGroup' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L1842 |
R4037 - MissingTypeObject |
The schema 'GalleryApplication' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L1967 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L1981 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L1995 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationVersion' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L2036 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationVersionUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L2050 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationVersionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L2064 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationVersionPublishingProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L2093 |
R4037 - MissingTypeObject |
The schema 'UserArtifactSource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L2116 |
R4037 - MissingTypeObject |
The schema 'UserArtifactManage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L2132 |
R4037 - MissingTypeObject |
The schema 'GalleryImage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L2152 |
R4037 - MissingTypeObject |
The schema 'GalleryImageUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L2166 |
R4037 - MissingTypeObject |
The schema 'GalleryImageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L2180 |
R4037 - MissingTypeObject |
The schema 'GalleryImageVersion' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/gallery.json#L2286 |
️⚠️
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 |
️️✔️
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.3)
- 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 |
---|---|
1019 - RemovedEnumValue |
The new version is removing enum value(s) 'Community' from the old version. New: stable/2022-01-03/GalleryRP/gallery.json#L1845: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/fd6bae5f5c9407bf8f66ce57792a425202eb85ed/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#L2509: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#L2525:5 Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2371:5 |
️️✔️
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.
Swagger Generation Artifacts
|
Hi @kangsun-ctrl, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @kangsun-ctrl |
@@ -13,7 +13,7 @@ | |||
"targetRegions": [ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thank you for catching this error @kangsun-ctrl
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good. One breaking change to get approval
@kangsun-ctrl - Couple of things needed before your PR is ready for ARM review:
|
Hi Chris @mentat9, thanks for the headsup, i have chosen the right checkbox for this pr and I read the rp guidelines previously when I request ARM review. I think I am ready for the review, let me know if there is anything you need. Also, I am requesting breaking change approval from Jeffrey Richter at the same time. Thanks! |
@@ -325,6 +463,14 @@ | |||
"type": "string", | |||
"format": "date-time", | |||
"description": "The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." | |||
}, | |||
"excludeFromLatest": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ARM recommends string enums instead of booleans. Rather than adding booleans for selection filters, you could think of an include or exclude property with enum values, e.g. include: { All, AllButLatest }. If you use modelAsString: true, then over time you can add more enum values without adding a new API version. #Resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these are the same api model in the backend as https://github.com/kangsun-ctrl/azure-rest-api-specs/blob/4d0adaa99964df094beae44cecb08f01ea6e66e0/specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/gallery.json#L2440-L2443. So I think we can try to change them all in the new api version since we need this release go in fast for our public preview.
.../compute/resource-manager/Microsoft.Compute/stable/2022-01-03/GalleryRP/galleryRPCommon.json
Outdated
Show resolved
Hide resolved
@@ -605,6 +608,14 @@ | |||
"type": "string", | |||
"format": "date-time", | |||
"description": "The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." | |||
}, | |||
"excludeFromLatest": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
…rl/azure-rest-api-specs into gallery_01_03_release
@ArcturusZhang , we would like this to be merged ASAP. We are working on resolving the enum error and have approval for the breaking change. |
* 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>
* 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>
* 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>
* 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>
* set up feature branch 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 * gallery 01-03 release (#17985) * 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> * Add privacyStatement/Uri to communtiy gallery image (#18680) * update * update * update * update * update * update * Adds settings and advancedSettings to gallery application version (#18722) * 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 Co-authored-by: Theodore Chang <thchan@microsoft.com> Co-authored-by: kangsun-ctrl <69279251+kangsun-ctrl@users.noreply.github.com> Co-authored-by: Jiefeng Chen <51037443+BigCat20196@users.noreply.github.com> Co-authored-by: Bhaskar Brahma <bhbrahma@microsoft.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
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.