-
Notifications
You must be signed in to change notification settings - Fork 5.3k
GalleryRP 2022-08-03 release branch #25524
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
Conversation
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
communityGallery.json | 2022-08-03(de0750e) | 2022-03-03(main) |
gallery.json | 2022-08-03(de0750e) | 2022-03-03(main) |
gallery.json | 2022-08-03(de0750e) | 2020-09-30(main) |
galleryRPCommon.json | 2022-08-03(de0750e) | 2022-03-03(main) |
sharedGallery.json | 2022-08-03(de0750e) | 2022-03-03(main) |
sharedGallery.json | 2022-08-03(de0750e) | 2020-09-30(main) |
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.6) | new version | base version |
---|---|---|
package-2022-08-03 | package-2022-08-03(de0750e) | 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 |
---|---|
ResourceNameRestriction |
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L37 |
ResourceNameRestriction |
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L79 |
ResourceNameRestriction |
The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L79 |
ResourceNameRestriction |
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L124 |
ResourceNameRestriction |
The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L124 |
ResourceNameRestriction |
The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L124 |
ResourceNameRestriction |
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L172 |
ResourceNameRestriction |
The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L217 |
ResourceNameRestriction |
The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L217 |
MissingTypeObject |
The schema 'PirCommunityGalleryResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L267 |
MissingTypeObject |
The schema 'CommunityGalleryIdentifier' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L309 |
MissingTypeObject |
The schema 'CommunityGallery' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L353 |
MissingTypeObject |
The schema 'CommunityGalleryImage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L403 |
MissingTypeObject |
The schema 'CommunityGalleryImageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L417 |
MissingTypeObject |
The schema 'CommunityGalleryImageVersion' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L528 |
MissingTypeObject |
The schema 'CommunityGalleryImageVersionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L542 |
MissingTypeObject |
The schema 'CommunityGalleryImageIdentifier' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-08-03/communityGallery.json#L571 |
ResourceNameRestriction |
The resource name parameter 'galleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/gallery.json#L37 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: GalleryRP/stable/2022-08-03/gallery.json#L38 |
LroLocationHeader |
A 202 response should include an Location response header. Location: GalleryRP/stable/2022-08-03/gallery.json#L84 |
LroErrorContent |
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 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: GalleryRP/stable/2022-08-03/gallery.json#L113 |
LroPatch202 |
The async patch operation should return 202. Location: GalleryRP/stable/2022-08-03/gallery.json#L146 |
LroErrorContent |
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 |
ParametersInPointGet |
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 |
ParametersInPointGet |
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 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: GalleryRP/stable/2022-08-03/gallery.json#L237 |
LroLocationHeader |
A 202 response should include an Location response header. Location: GalleryRP/stable/2022-08-03/gallery.json#L265 |
LroErrorContent |
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 |
ResourceNameRestriction |
The resource name parameter 'galleryName' should be defined with a 'pattern' restriction. Location: GalleryRP/stable/2022-08-03/gallery.json#L286 |
️⚠️
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 |
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
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. |
* changes * prettier
…unity gallery (#25659) * all discalimer and previous arm updates * cleanup * prettier
...compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json
Show resolved
Hide resolved
...compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json
Show resolved
Hide resolved
This would require code changes |
This type doesn't really have that. The value would be unique but it is an array of strings so I don't think it belongs in x-ms-identifiers |
This is how their specified in APIs across other services as well and they're commonly referred to in this way in documentation. |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
shouldn't you specify an identifying property here? In reply to: 1718452994 Refers to: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json:3218 in d22af1c. [](commit_id = d22af1c, deletion_comment = False) |
.../compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json
Show resolved
Hide resolved
* update * update
Next Steps to MergeNext steps that must be taken to merge this PR:
|
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.
Adding ARMSignedOff label since Tim approved the PR, and mentioned it in our email thread. |
/pr RequestMerge |
ARM (Control Plane) API Specification Update Pull Request
Moved the release code from this PR: #24661
This PR has the CI-MissingBaseCommit because the tool that creates the release PRs automatically cannot handle an API with multiple RPs as it only migrates one of them. I manually made the base commits.
These new features are going into this release. They have been previously reviewed by ARM, but please go ahead and re-review:
Edits based on ARM comments:
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.