Merged
Conversation
some new api ver all api versions exs move common
|
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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| communityGallery.json | 2022-03-03(af0c875) | 2022-01-03(main) |
| gallery.json | 2022-03-03(af0c875) | 2022-01-03(main) |
| gallery.json | 2022-03-03(af0c875) | 2020-09-30(main) |
| galleryRPCommon.json | 2022-03-03(af0c875) | 2022-01-03(main) |
| sharedGallery.json | 2022-03-03(af0c875) | 2022-01-03(main) |
| sharedGallery.json | 2022-03-03(af0c875) | 2020-09-30(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 4 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-03-03 | package-2022-03-03(af0c875) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: required Location: GalleryRP/stable/2022-03-03/gallery.json#L2179 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: excludeFromLatest Location: GalleryRP/stable/2022-03-03/gallery.json#L2535 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowDeletionOfReplicatedLocations Location: GalleryRP/stable/2022-03-03/gallery.json#L2837 |
||
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: reportedForPolicyViolation Location: GalleryRP/stable/2022-03-03/gallery.json#L2847 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
R4037 - MissingTypeObject |
The schema 'PirCommunityGalleryResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L267 |
R4037 - MissingTypeObject |
The schema 'CommunityGalleryIdentifier' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L291 |
R4037 - MissingTypeObject |
The schema 'CommunityGallery' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L300 |
R4037 - MissingTypeObject |
The schema 'CommunityGalleryImage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L330 |
R4037 - MissingTypeObject |
The schema 'CommunityGalleryImageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L344 |
R4037 - MissingTypeObject |
The schema 'CommunityGalleryImageVersion' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L449 |
R4037 - MissingTypeObject |
The schema 'CommunityGalleryImageVersionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/communityGallery.json#L463 |
R4037 - MissingTypeObject |
The schema 'Gallery' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L1738 |
R4037 - MissingTypeObject |
The schema 'GalleryUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L1752 |
R4037 - MissingTypeObject |
The schema 'GalleryProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L1766 |
R4037 - MissingTypeObject |
The schema 'GalleryIdentifier' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L1792 |
R4037 - MissingTypeObject |
The schema 'SharingProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L1802 |
R4037 - MissingTypeObject |
The schema 'SharingProfileGroup' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L1833 |
R4037 - MissingTypeObject |
The schema 'GalleryApplication' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L1958 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L1972 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L1986 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationVersion' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2037 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationVersionUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2051 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationVersionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2065 |
R4037 - MissingTypeObject |
The schema 'GalleryApplicationVersionPublishingProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2087 |
R4037 - MissingTypeObject |
The schema 'UserArtifactSource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2210 |
R4037 - MissingTypeObject |
The schema 'UserArtifactManage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2226 |
R4037 - MissingTypeObject |
The schema 'GalleryImage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2260 |
R4037 - MissingTypeObject |
The schema 'GalleryImageUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2274 |
R4037 - MissingTypeObject |
The schema 'GalleryImageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2288 |
R4037 - MissingTypeObject |
The schema 'GalleryImageVersion' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2384 |
R4037 - MissingTypeObject |
The schema 'GalleryImageVersionUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2398 |
R4037 - MissingTypeObject |
The schema 'GalleryImageVersionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2412 |
R4037 - MissingTypeObject |
The schema 'GalleryArtifactPublishingProfileBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2437 |
R4037 - MissingTypeObject |
The schema 'TargetRegion' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: GalleryRP/stable/2022-03-03/gallery.json#L2508 |
️⚠️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-03-03 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️~[Staging] TrafficValidation 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.
️❌SDK Track2 Validation: 2 Errors, 1 Warnings failed [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/af0c875c19f12d8e5f3f895380f91f1e35de40c6/specification/compute/resource-manager/readme.md#tag-package-2022-03-03">compute/resource-manager/readme.md#package-2022-03-03
- "https://github.com/Azure/azure-rest-api-specs/blob/af0c875c19f12d8e5f3f895380f91f1e35de40c6/specification/compute/resource-manager/readme.md#tag-package-2022-03-03-only">compute/resource-manager/readme.md#package-2022-03-03-only
| Rule | Message |
|---|---|
PreCheck/DuplicateSchema |
"readme":"compute/resource-manager/readme.md", "tag":"package-2022-03-03", "details":"Duplicate Schema named 'PurchasePlan' (1 differences):\n - properties.promotionCode: => "$ref":"#/components/schemas/schemas:1405", "description":"The Offer Promotion Code."; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2022-03-03", "details":"Error: 1 errors occured -- cannot continue." |
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-03-03-only", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Aug 25, 2022
This was referenced Aug 29, 2022
for release.
|
Hi, @Sandido your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Member
Member
ArcturusZhang
approved these changes
Sep 29, 2022
This was referenced Sep 29, 2022
1 task
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
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.
ARM API Information (Control Plane)
Swagger PR being merged to this branch is: #20398
This PR was signed off for the breaking changes in this PR because the functionality was broken for customers so these changes will not hurt customers.
The individual SDK owners have approved this breaking change as well.
.Net changes for this branch are here: https://github.com/Azure/azure-sdk-for-net/pull/29817/files
And the .Net changes for the new features are here: Azure/azure-sdk-for-net#30125
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.