GalleryRP 2022-08-03 release #23113
Draft
GalleryRP 2022-08-03 release #23113
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
|
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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| communityGallery.json | 2022-08-03(f0866b0) | 2022-03-03(main) |
| gallery.json | 2022-08-03(f0866b0) | 2022-03-03(main) |
| gallery.json | 2022-08-03(f0866b0) | 2020-09-30(main) |
| galleryRPCommon.json | 2022-08-03(f0866b0) | 2022-03-03(main) |
| sharedGallery.json | 2022-08-03(f0866b0) | 2022-03-03(main) |
| sharedGallery.json | 2022-08-03(f0866b0) | 2020-09-30(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version has a different x-ms-enum 'name' than the previous one. New: GalleryRP/stable/2022-08-03/gallery.json#L2560:9 Old: GalleryRP/stable/2022-03-03/gallery.json#L2560:9 |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2022-08-03 | package-2022-08-03(f0866b0) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L37 |
|
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L79 |
|
The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L79 |
|
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L124 |
|
The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L124 |
|
The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L124 |
|
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L172 |
|
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L217 |
|
The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L217 |
|
The resource name parameter 'galleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/gallery.json#L37 |
|
Description of 200 response code of a PUT operation MUST include term 'update'. Location: GalleryRP/stable/2022-08-03/gallery.json#L71 |
|
A 202 response should include an Location response header. Location: GalleryRP/stable/2022-08-03/gallery.json#L84 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: GalleryRP/stable/2022-08-03/gallery.json#L93 |
|
LRO PATCH must have 200 and 202 return codes. Location: GalleryRP/stable/2022-08-03/gallery.json#L113 |
|
The async patch operation should return 202. Location: GalleryRP/stable/2022-08-03/gallery.json#L146 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: GalleryRP/stable/2022-08-03/gallery.json#L156 |
|
Query parameter $select should be removed. Point Get's MUST not have query parameters other than api version. Location: GalleryRP/stable/2022-08-03/gallery.json#L173 |
|
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: GalleryRP/stable/2022-08-03/gallery.json#L173 |
|
A 202 response should include an Location response header. Location: GalleryRP/stable/2022-08-03/gallery.json#L265 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: GalleryRP/stable/2022-08-03/gallery.json#L274 |
|
The resource name parameter 'galleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/gallery.json#L286 |
|
The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/gallery.json#L286 |
|
Description of 200 response code of a PUT operation MUST include term 'update'. Location: GalleryRP/stable/2022-08-03/gallery.json#L327 |
|
A 202 response should include an Location response header. Location: GalleryRP/stable/2022-08-03/gallery.json#L340 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: GalleryRP/stable/2022-08-03/gallery.json#L349 |
|
LRO PATCH must have 200 and 202 return codes. Location: GalleryRP/stable/2022-08-03/gallery.json#L360 |
|
The async patch operation should return 202. Location: GalleryRP/stable/2022-08-03/gallery.json#L400 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: GalleryRP/stable/2022-08-03/gallery.json#L410 |
|
A 202 response should include an Location response header. Location: GalleryRP/stable/2022-08-03/gallery.json#L507 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: GalleryRP/stable/2022-08-03/gallery.json#L516 |
️⚠️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-08-03 |
️️✔️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]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 5 Errors, 0 Warnings failed [Detail]
️️✔️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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
|
Hi, @Sandido, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
This was referenced Mar 15, 2023
[AutoPR Azure.ResourceManager.Compute] GalleryRP 2022-08-03 release
azure-sdk/azure-sdk-for-net#3028
Closed
* test id addition to create gallery * rest of create gallery example * fix most errors * more ids * commit empty prettier
…unity gallery. (#23505) * save * save * nit * fix format * nit * update * fix check
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @Sandido, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
* test id addition to create gallery * rest of create gallery example * fix most errors * more ids * commit empty prettier * missing responses fix * cleanup
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
8 tasks
Next Steps to MergeNext steps that must be taken to merge this PR:
|
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 release of the 2022-08-03 Gallery RP api release.
These PRs are merged into this branch:
ARM API Information (Control Plane)
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.