-
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
Add alert update operation #14840
Add alert update operation #14840
Conversation
Hi, @orkayam 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. vsswagger@microsoft.com |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Hi, @orkayam your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Validation Report
|
Rule | Message |
---|---|
1029 - ReadonlyPropertyChanged |
The read only property has changed from 'true' to 'false'. New: Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json#L322:9 Old: Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json#L236:9 |
1039 - AddedOperation |
The new version is adding an operation that was not found in the old version. New: Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json#L133:7 |
1041 - AddedPropertyInResponse |
The new version has a new property 'status' in response that was not found in the old version. New: Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json#L266:7 Old: Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json#L180:7 |
️⚠️
LintDiff: 2 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
Rule | Message |
---|---|
'PATCH' operation 'IotAlerts_Patch' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json#L142 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.IoTSecurity/preview/2021-07-01-preview/alerts.json#L424 |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
Based on the response model schema, operation 'AlertTypes_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.IoTSecurity/preview/2021-07-01-preview/alertTypes.json#L38 |
|
Based on the response model schema, operation 'RecommendationTypes_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.IoTSecurity/preview/2021-07-01-preview/recommendationTypes.json#L38 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json#L137 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: toBeExportedForCustomer Location: Microsoft.IoTSecurity/preview/2021-02-01-preview/operations.json#L306 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"iotsecurity/resource-manager/readme.md",
"tag":"2021-07-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"iotsecurity/resource-manager/readme.md",
"tag":"2021-07-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"iotsecurity/resource-manager/readme.md",
"tag":"2021-07-01-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
Hi @orkayam, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
NewApiVersionRequired reason: |
* add new resources * Add resources to markdown * Modify routes * Add systemData * Add systemData to defenderSettings * Add missing parameter * Add more systemData * Fix example * Add new API version * Remove redundant change * update markdown * Add operations to new API version * Update list filters * update description * update examples * Update examples * Add missing properties * Add missing properties * Rename property * Add alert editing * Update editable properties * Update example * update put to patch * Separate patch request to a different model * Share enum * update example * update patch model * Undo break change * small update Co-authored-by: Orel Kayam <orkayam@microsoft.com>
* add new resources * Add resources to markdown * Modify routes * Add systemData * Add systemData to defenderSettings * Add missing parameter * Add more systemData * Fix example * Add new API version * Remove redundant change * update markdown * Add operations to new API version * Update list filters * update description * update examples * Update examples * Add missing properties * Add missing properties * Rename property * Add alert editing * Update editable properties * Update example * update put to patch * Separate patch request to a different model * Share enum * update example * update patch model * Undo break change * small update Co-authored-by: Orel Kayam <orkayam@microsoft.com>
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.