-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
[Hub Generated] Review request for Microsoft.Chaos to add version preview/2023-04-15-preview #23443
[Hub Generated] Review request for Microsoft.Chaos to add version preview/2023-04-15-preview #23443
Conversation
Hi, @brrusino 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.10.4)] | new version | base version |
---|---|---|
capabilities.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
capabilityTypes.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
experiments.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
operations.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
targetTypes.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
targets.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
capabilities.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
capabilityTypes.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
common.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
experiments.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
targetTypes.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
targets.json | 2023-04-15-preview(5d2652a) | 2023-04-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2023-04-15-preview | package-2023-04-15-preview(5d2652a) | default(main) |
package-2023-04-01-preview | package-2023-04-01-preview(5d2652a) | default(main) |
package-2022-10-01-preview | package-2022-10-01-preview(5d2652a) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
GetCollectionResponseSchema |
The response in the GET collection operation 'Capabilities_List' does not match the response definition in the individual GET operation 'Capabilities_Get' . Location: Microsoft.Chaos/preview/2023-04-15-preview/capabilities.json#L37 |
GetCollectionResponseSchema |
The response in the GET collection operation 'CapabilityTypes_List' does not match the response definition in the individual GET operation 'CapabilityTypes_Get' . Location: Microsoft.Chaos/preview/2023-04-15-preview/capabilityTypes.json#L37 |
GetCollectionResponseSchema |
The response in the GET collection operation 'Experiments_ListAll' does not match the response definition in the individual GET operation 'Experiments_Get' . Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L37 |
PostOperationAsyncResponseValidation |
An async POST operation must set ''x-ms-long-running-operation' : true''. Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L311 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L311 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L332 |
PostOperationAsyncResponseValidation |
An async POST operation must set ''x-ms-long-running-operation' : true''. Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L353 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L353 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L374 |
GetCollectionResponseSchema |
The response in the GET collection operation 'Experiments_ListAllStatuses' does not match the response definition in the individual GET operation 'Experiments_GetStatus' . Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L394 |
GetCollectionResponseSchema |
The response in the GET collection operation 'Experiments_ListExecutionDetails' does not match the response definition in the individual GET operation 'Experiments_GetExecutionDetails' . Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L484 |
GetCollectionResponseSchema |
The response in the GET collection operation 'Targets_List' does not match the response definition in the individual GET operation 'Targets_Get' . Location: Microsoft.Chaos/preview/2023-04-15-preview/targets.json#L37 |
GetCollectionResponseSchema |
The response in the GET collection operation 'TargetTypes_List' does not match the response definition in the individual GET operation 'TargetTypes_Get' . Location: Microsoft.Chaos/preview/2023-04-15-preview/targetTypes.json#L37 |
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/capabilities.json#L44 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/capabilities.json#L101 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/capabilities.json#L153 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/capabilities.json#L205 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/capabilityTypes.json#L44 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/capabilityTypes.json#L92 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L44 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L89 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L137 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L177 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L217 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L266 |
|
Operations with a 202 response should specify x-ms-long-running-operation: true .Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L311 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L317 |
|
Operations with a 202 response should specify x-ms-long-running-operation: true .Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L353 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L359 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Chaos/preview/2023-04-15-preview/experiments.json#L401 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView 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.
️️✔️
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.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi, @brrusino your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
"Random", | ||
"Tag", | ||
"List" | ||
"List", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Previously, List
was the only value supported by Chaos Studio. These previous existing enum values were never actually supported, and were added a long time ago.
@MaryGao , can you please take a look at this PR? We are aware of the mentioned breaking changes and would like to proceed regardless. |
I'll take a look once the ARM team reviewed |
], | ||
"x-ms-enum": { | ||
"name": "SelectorType", | ||
"modelAsString": false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No explicit reason, string works for us - will change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
changes applied
], | ||
"x-ms-enum": { | ||
"name": "FilterType", | ||
"modelAsString": false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed back to true
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
@MaryGao Is anything else required to complete this PR? |
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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.