-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Feature/gallery 220303 72 #20296
base: main
Are you sure you want to change the base?
Feature/gallery 220303 72 #20296
Conversation
readme only lower case ech from v1 to actual version
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(b8ddcda) | 2022-01-03(main) |
gallery.json | 2022-03-03(b8ddcda) | 2022-01-03(main) |
gallery.json | 2022-03-03(b8ddcda) | 2020-09-30(main) |
galleryRPCommon.json | 2022-03-03(b8ddcda) | 2022-01-03(main) |
sharedGallery.json | 2022-03-03(b8ddcda) | 2022-01-03(main) |
sharedGallery.json | 2022-03-03(b8ddcda) | 2020-09-30(main) |
The following breaking changes are detected by comparison with the 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/b8ddcdae06befb2a54babbea6f6b9856af5b74cb/revision#L1024:2 Old: GalleryRP/preview/2020-09-30/sharedGallery.json#L762:3 |
|
The new version has a different type 'object' than the previous one ''. New: galleryRP/stable/2022-03-03/gallery.json#L2491:9 Old: GalleryRP/preview/2020-09-30/gallery.json#L2358:9 |
|
The new version has a different type 'object' than the previous one ''. New: galleryRP/stable/2022-03-03/gallery.json#L2507:5 Old: GalleryRP/preview/2020-09-30/gallery.json#L2371:5 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 1 Errors, 0 Warnings failed [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-03-03 | package-2022-03-03(b8ddcda) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
R3012 - APIVersionPattern |
API Version must be in the format: yyyy-MM-dd, optionally followed by -preview, -alpha, -beta, -rc, -privatepreview. Location: Microsoft.Compute/common-types/v1/common.json#L6 |
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 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L38 |
R4037 - MissingTypeObject |
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L38 |
R4037 - MissingTypeObject |
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L38 |
R4037 - MissingTypeObject |
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L38 |
R4037 - MissingTypeObject |
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L55 |
R4037 - MissingTypeObject |
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L55 |
R4037 - MissingTypeObject |
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L55 |
R4037 - MissingTypeObject |
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L55 |
R4037 - MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L68 |
R4037 - MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L68 |
R4037 - MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L68 |
R4037 - MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L68 |
R4037 - MissingTypeObject |
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L77 |
R4037 - MissingTypeObject |
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L77 |
R4037 - MissingTypeObject |
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L77 |
R4037 - MissingTypeObject |
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L77 |
R4037 - MissingTypeObject |
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L109 |
R4037 - MissingTypeObject |
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L109 |
R4037 - MissingTypeObject |
The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L144 |
R4037 - MissingTypeObject |
The schema 'SubResourceReadOnly' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L153 |
R4037 - MissingTypeObject |
The schema 'ExtendedLocation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/common-types/v1/common.json#L207 |
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#L1735 |
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#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-03-03 |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
Service API Readiness Test failed. Check pipeline artifact for detail report.️️✔️
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/b8ddcdae06befb2a54babbea6f6b9856af5b74cb/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/b8ddcdae06befb2a54babbea6f6b9856af5b74cb/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:1443", "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.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @Sandido, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Trying common.json with version 1.0.
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:
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 appy 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 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.