Azure
GalleryRP 2022-08-03 release
The release of the 2022-08-03 Gallery RP api release.
These PRs are merged into this branch:
- https://github.com/Azure/azure-rest-api-specs/pull/23197
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:
- What's the purpose of the update?
- [ ] new service onboarding
- [ ] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [ ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [ ] I have reviewed the documentation for the workflow.
- [ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
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.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] 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.
Hi, @Sandido Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 1 Errors, 19 Warnings failed [Detail]
| 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 |
|---|---|
| :warning: MULTIPLE_API_VERSION | 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.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️❌SDK Breaking Change Tracking failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-sdk-for-net-track2 failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-sdk-for-python-track2 warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-sdk-for-java warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-resource-manager-schemas warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-powershell failed [Detail]
Only 0 items are rendered, please refer to log for more details.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Microsoft.Compute | https://apiview.dev/Assemblies/Review/5c40e621ba164d80a126311d01831d12 |
| Go | sdk/resourcemanager/compute/armcompute | https://apiview.dev/Assemblies/Review/4174d9997d5a42458cbd26076c61887f |
| Java | azure-resourcemanager-compute-generated | https://apiview.dev/Assemblies/Review/d45eb74c4f1945f1800f9a1404b81430 |
| JavaScript | @azure/arm-compute | https://apiview.dev/Assemblies/Review/c92267b7cf3c4dcc9efddc9982545f2a |
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
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. 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. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
Next Steps to Merge
Next steps that must be taken to merge this PR:- ❌ Your PR has at least one breaking change (label:
BreakingChangeReviewRequired). See the PR description for help. - ❌ The required check named
Swagger ModelValidationhas failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.