Alert Rules - add alert details override changes and PUT example #22196
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
|
Hi, @ShaniFelig 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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| AlertRules.json | 2023-02-01(e00bf15) | 2022-11-01(main) |
| AlertRules.json | 2023-02-01(e00bf15) | 2022-12-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-02 | package-2023-02(e00bf15) | package-2023-02(release-Sentinel-2023-02-01) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Actions_CreateOrUpdate' Request Model: 'parameters[6].schema' Response Model: 'responses[200].schema' Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L329 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L827 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1027 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1336 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1353 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1357 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1469 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.SecurityInsights/stable/2023-02-01/AlertRules.json#L1484 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @ShaniFelig your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Generated ApiView
|
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced Jan 16, 2023
laithhisham
approved these changes
Jan 17, 2023
raosuhas
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
@dw511214992 Can we get this approved please? |
|
@raosuhas thanks for the sign off. Can you please merge the PR as well? |
dw511214992
pushed a commit
that referenced
this pull request
Feb 22, 2023
* Adds base for updating Microsoft.SecurityInsights from version stable/2022-11-01 to version 2023-02-01 * Updates readme * Updates API version in new specs and examples * Provider sync properties (#22198) * Alert Rules - add alert details override changes and PUT example (#22196) * add alert details override changes and PUT example * add missing brace * add closing brace for alertDetailsOverride * add dynamic properties to 200 response * add dynamic details to 201 response --------- Co-authored-by: ShaniFelig <[email protected]> * Release Metadata 2023-02-01 stable version. (#22161) * Release Metadata 2023-02-01 stable version. * Fix Swagger spec validation errors. * Revert Metadata service version to 2022-12-01-preview * Bring back changes for version 2023-02-01 * Fix model validation --------- Co-authored-by: Dor Siso <[email protected]> Co-authored-by: ShaniFelig <[email protected]> Co-authored-by: ShaniFelig <[email protected]> Co-authored-by: Samuel Kuang <[email protected]>
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
* Adds base for updating Microsoft.SecurityInsights from version stable/2022-11-01 to version 2023-02-01 * Updates readme * Updates API version in new specs and examples * Provider sync properties (Azure#22198) * Alert Rules - add alert details override changes and PUT example (Azure#22196) * add alert details override changes and PUT example * add missing brace * add closing brace for alertDetailsOverride * add dynamic properties to 200 response * add dynamic details to 201 response --------- Co-authored-by: ShaniFelig <[email protected]> * Release Metadata 2023-02-01 stable version. (Azure#22161) * Release Metadata 2023-02-01 stable version. * Fix Swagger spec validation errors. * Revert Metadata service version to 2022-12-01-preview * Bring back changes for version 2023-02-01 * Fix model validation --------- Co-authored-by: Dor Siso <[email protected]> Co-authored-by: ShaniFelig <[email protected]> Co-authored-by: ShaniFelig <[email protected]> Co-authored-by: Samuel Kuang <[email protected]>
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.
ARM API Information (Control Plane)
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 (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.