CloudService 2022-04-04 release #19468
Merged
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
* set up feature branch * Update cloud service swagger file and examples (#19311) * Update cloud service swagger file and examples * Update cloudService.json Co-authored-by: Arpit Khandelwal <arkhande@microsoft.com> * move systemData object to common.json * Add CloudServiceSlotType to swagger api 2022-04-04 (#19361) Co-authored-by: Arpit Khandelwal <arkhande@microsoft.com> * update with prettier * resolve readme input * add missing example * fix example error, update common with latest change. * set up branch * change folder name * change folder name Co-authored-by: Arpit Khandelwal <arpitkhandelwal@hotmail.com> Co-authored-by: Arpit Khandelwal <arkhande@microsoft.com> Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com>
|
Hi, @grizzlytheodore 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
|
| Rule | Message |
|---|---|
| 'SubResource' 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-04-04/common.json#L144 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Cloud Service Role Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L576 |
The following errors/warnings exist before current PR submission:
Only 22 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-04-04/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-04-04/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-04-04/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-04-04/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-04-04/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-04-04/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-04-04/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-04-04/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-04-04/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-04-04/common.json#L144 |
|
The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Compute/stable/2022-04-04/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-04-04/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-04-04/common.json#L207 |
|
The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path. Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L38 |
|
The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path. Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L97 |
|
The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path. Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L168 |
|
The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path. Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L292 |
|
The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path. Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L350 |
|
The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path. Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L408 |
|
The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path. Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L466 |
|
The parameters:roleName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path. Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L527 |
| 'PUT' operation 'CloudServicesUpdateDomain_WalkUpdateDomain' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L1346 |
️⚠️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-04-04 |
️️✔️ApiReadinessCheck 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: 3 Errors, 99 Warnings failed [Detail]
- The following tags are being changed in this PR
Only 22 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Process() cancelled due to failure " |
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"!Error: Plugin prechecker reported failure." |
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing." |
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.0.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.1.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.2.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.3.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.4.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.5.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.6.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.7.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.8.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.9.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.10.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.11.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.12.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.13.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.14.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.15.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.16.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.17.suppress which is deprecated and will be removed in the future." |
|
| "readme":"compute/resource-manager/readme.md", "tag":"package-2022-04-04", "details":"Using directive.18.suppress which is deprecated and will be removed in the future." |
️️✔️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
|
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @grizzlytheodore your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
grizzlytheodore
requested review from
Sandido,
dkulkarni-ms,
haagha,
madewithsmiles,
MS-syh2qs and
hyonholee
as code owners
11 tasks
|
breaking change approved in: #19311 |
|
Hi @grizzlytheodore, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Jun 15, 2022
zizw123
reviewed
Jun 16, 2022
| }, | ||
| "description": "Api error." | ||
| }, | ||
| "Resource": { |
There was a problem hiding this comment.
Consider if you can use common type: https://github.com/Azure/azure-rest-api-specs-pr/blob/main/specification/common-types/resource-management/v3/types.json
Same for other types in this file
There was a problem hiding this comment.
there's about 100 references to this object for all the resources in compute, so we will keep it as is
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
grizzlytheodore
added
the
WaitForARMFeedback
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
rkmanda
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
this is ready for merge |
ArcturusZhang
approved these changes
Jun 23, 2022
This was referenced Jun 23, 2022
Closed
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.
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.