Compute Gallery RP new API version 2022-01-03 #18172
Closed
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
|
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 pipeline can not start as the pull request has merge conflicts. |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
|
Swagger pipeline can not start as the pull request has merge conflicts. |
ghost
added
the
* 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>
|
Swagger pipeline can not start as the pull request has merge conflicts. |
1 similar comment
|
Swagger pipeline can not start as the pull request has merge conflicts. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Sandido
requested review from
msyyc,
BigCat20196,
Sandido,
dkulkarni-ms,
haagha,
madewithsmiles,
MS-syh2qs and
hyonholee
as code owners
|
The CI pipelines seem stuck, I don't know why. Despite trying to use '/azp run'. |
|
@ArcturusZhang , please review this PR. The Breaking Changes and ARM review has already occurred in the original feature branch PR. |
Sandido
changed the title
Sandido
added
the
DoNotMerge
|
Added Do Not Merge because the .Net SDK PR still needs updating. Azure/azure-sdk-for-net#27466 |
SDK pr has all tests passing now, @ArcturusZhang can you take a look? Thanks! |
|
/azp run |
|
Hi @grizzlytheodore any update on this PR? |
* update * update * update * update * update * update
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#L174 |
|
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 |
️️✔️~[Staging] 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.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 |
|---|---|
|
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/6190de476be120065c49144d96cfae9ee72a92a6/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 Generation Artifacts
|
|
Hi @grizzlytheodore, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Please hold on merge until @josefree confirm final folder structure design |
fix mistake made in example name
|
Hold off on merging as we have another PR looking to be merged into this branch: #18722 |
…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
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @grizzlytheodore 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
|
Closing as I will be using this new PR going forward that has the correct commit history for the ARM team: #18976 |
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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:
.Net PR = SDK changes for new properties "settings" and "advancedSettings" to gallery application version azure-sdk-for-net#28250
.Net PR = Gallery 01 03 SDK azure-sdk-for-net#27466
.Net PR = add eula/privacy statement to gallery SDK release azure-sdk-for-net#28238
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.