Add new API version "2022-07-01-preview" for CapabilityType#19489
Add new API version "2022-07-01-preview" for CapabilityType#19489jianyexi merged 24 commits intoAzure:mainfrom victoriachenm:dev-chaos-Microsoft.Chaos-2022-07-01-preview
Conversation
|
Hi, @victoriachenm 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.6)] | new version | base version |
|---|---|---|
| capabilities.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| capabilityTypes.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| experiments.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| operations.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| targetTypes.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| targets.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| capabilities.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| capabilityTypes.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| common.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| experiments.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| targetTypes.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
| targets.json | 2022-07-01(e6d71c4) | 2021-09-15(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Chaos/preview/2022-07-01-preview/experiments.json#L211:7 Old: Microsoft.Chaos/preview/2021-09-15-preview/experiments.json#L211:7 |
|
| The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Chaos/preview/2022-07-01-preview/experiments.json#L262:7 Old: Microsoft.Chaos/preview/2021-09-15-preview/experiments.json#L266:7 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-07-01-preview | package-2022-07-01-preview(e6d71c4) | default(main) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| The operation 'Experiments_Cancel' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Chaos/preview/2022-07-01-preview/experiments.json#L262 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| The operation 'Experiments_Start' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Chaos/preview/2022-07-01-preview/experiments.json#L304 |
|
| The child tracked resource, 'capabilities' with immediate parent 'target', must have a list by immediate parent operation. Location: preview/2022-07-01-preview/types/capabilities.json#L9 |
|
| The child tracked resource, 'statuses' with immediate parent 'experiment', must have a list by immediate parent operation. Location: preview/2022-07-01-preview/types/experiments.json#L415 |
|
| The child tracked resource, 'executionDetails' with immediate parent 'experiment', must have a list by immediate parent operation. Location: preview/2022-07-01-preview/types/experiments.json#L559 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: startOnCreation Location: preview/2022-07-01-preview/types/experiments.json#L98 |
|
| The tracked resource, 'experiment', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: preview/2022-07-01-preview/types/experiments.json#L47 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/e6d71c439f398686ff9902e9d89d5333cdf21aa9/specification/chaos/resource-manager/readme.md#tag-package-2022-07-01-preview">chaos/resource-manager/readme.md#package-2022-07-01-preview
| Rule | Message |
|---|---|
| "readme":"chaos/resource-manager/readme.md", "tag":"package-2022-07-01-preview", "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
|
|
Hi, @victoriachenm your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
Hi @victoriachenm, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Is every file in this PR new changes? If any of them are from previous API version, please follow this: The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" tag once you have fixed this issue. |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
This reverts commit 5095ea2. Reverting because first commit needs to be the previous API version
|
Hi @msyyc @BigCat20196, can you take a look at and help approve the changes? The only failing check is for SDK breaking changes, for which I will generate a new version of the SDK following the merging of these changes. Thanks! |
|
Approved for python breaking change |
Thanks @msyyc ! Can you help with merging the change? It looks like I am not authorized to do the merge. |
assignee is responsible to merge the pr when it is ready |
|
@jianyexi Can you help review and merge the change? |
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/cancel": { | ||
| "post": { | ||
| "description": "Cancel a running Experiment resource.", |
There was a problem hiding this comment.
this operatino used to have 'x-ms-longrunning-operation': true, why remove it ?
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@victoriachenm could you fix the model validation error ? |
|
@BigCat20196 @msyyc can you help approve and merge this PR? |
|
Approved for python breaking change and please contact assignee @jianyexi to merge the PR |
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.
-[x] 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.