Draft PR for 2022-01-03 Gallery Swagger release, see if CI checks run #18287
Conversation
This file contains 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
* save * update * update * update * update * update * update * nit * 'save' * add * update * add architecture * update * update * Update readme add `package-2022-01-03-only` tag for python * save * nit Co-authored-by: Jiefeng Chen <51037443+BigCat20196@users.noreply.github.com>
ghost
added
the
|
/azp run |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: stable/2022-01-03/GalleryRP/galleryRPCommon.json#L212 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: excludeFromLatest Location: stable/2022-01-03/GalleryRP/communityGallery.json#L467 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: excludeFromLatest Location: stable/2022-01-03/GalleryRP/sharedGallery.json#L612 |
|
| 'SubResourceReadOnly' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Compute/stable/2022-01-03/common.json#L153 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get a community gallery. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L72 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: stable/2022-01-03/GalleryRP/gallery.json#L1772 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: stable/2022-01-03/GalleryRP/gallery.json#L2069 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: stable/2022-01-03/GalleryRP/gallery.json#L2251 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: stable/2022-01-03/GalleryRP/gallery.json#L2319 |
|
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L38 |
|
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L38 |
|
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L38 |
|
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L38 |
|
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L55 |
|
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L55 |
|
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L55 |
|
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L55 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L68 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L68 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L68 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L68 |
|
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L77 |
|
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L77 |
|
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L77 |
|
The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L77 |
|
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L109 |
|
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L109 |
|
The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L144 |
|
The schema 'SubResourceReadOnly' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L153 |
|
The schema 'ExtendedLocation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-01-03/common.json#L174 |
|
The schema 'PirCommunityGalleryResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L267 |
|
The schema 'CommunityGalleryIdentifier' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L291 |
|
The schema 'CommunityGallery' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L300 |
|
The schema 'CommunityGalleryImage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L330 |
|
The schema 'CommunityGalleryImageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: stable/2022-01-03/GalleryRP/communityGallery.json#L344 |
️❌Avocado: 1 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The example JSON file is not referenced from the swagger file. readme: specification/compute/resource-manager/readme.md json: GalleryRP/examples/galleryExamples/GalleryImageVersion_Create_WithImageVersionAsSource.json |
| 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-01-03 |
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 1 Errors, 3 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:2022-01-03/GalleryRP/communityGallery.json compared with base:stable/2021-07-01/communityGallery.json
- current:2022-01-03/GalleryRP/gallery.json compared with base:stable/2021-10-01/gallery.json
- current:2022-01-03/GalleryRP/gallery.json compared with base:preview/2020-09-30/gallery.json
- current:2022-01-03/GalleryRP/sharedGallery.json compared with base:stable/2021-07-01/sharedGallery.json
- current:2022-01-03/GalleryRP/sharedGallery.json compared with base:preview/2020-09-30/sharedGallery.json
| Rule | Message |
|---|---|
|
The new version is removing enum value(s) 'Community' from the old version. New: stable/2022-01-03/GalleryRP/gallery.json#L1845:9 Old: Microsoft.Compute/stable/2021-10-01/gallery.json#L1844:9 |
The following breaking changes are detected by comparison with 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/4c1edab2b55009607fdbbfc908658168bb1dc300/revision:1024:2 Old: Microsoft.Compute/preview/2020-09-30/sharedGallery.json#L762:3 |
|
| The new version has a different type 'object' than the previous one ''. New: stable/2022-01-03/GalleryRP/gallery.json#L2509:9 Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2358:9 |
|
| The new version has a different type 'object' than the previous one ''. New: stable/2022-01-03/GalleryRP/gallery.json#L2525:5 Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2371:5 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Hi @Sandido, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Mar 18, 2022
This was referenced Mar 18, 2022
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
This PR is merging in all changes for the Gallery 2022-01-03 API version.
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 apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.