[Hub Generated] Review request for Microsoft.SecurityInsights to remove unused endpoints under Settings #14380
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
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/onboard' removed or restructured? Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L225:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/offboard' removed or restructured? Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L273:5 |
|
The new version is missing a definition that was found in the old version. Was 'OnboardingRequest' removed or renamed? New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L226:3 Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L316:3 |
|
The new version is missing a definition that was found in the old version. Was 'EntityAnalyticsOnboardingParameters' removed or renamed? New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L226:3 Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L316:3 |
|
The new version is missing a client parameter that was found in the old version. Was 'OnboardingRequest' removed or renamed? New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L392:3 Old: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L520:3 |
️⚠️LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.SecurityInsights/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/operations.json#L37 |
| 'PUT' operation 'ProductSettings_Update' 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: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L185 |
|
| Based on the response model schema, operation 'ProductSettings_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L38 |
|
| Based on the response model schema, operation 'SentinelOnboardingStates_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/OnboardingStates.json#L187 |
|
| Sku Model definition 'Sku' is not valid. A Sku model must have 'name' property. It can also have 'tier', 'size', 'family', 'capacity' as optional properties. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L369 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SourceControlModel'. Consider using the plural form of 'SourceControl' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/SourceControls.json#L48 |
|
| The child tracked resource, 'watchlistItems' with immediate parent 'Watchlist', must have a list by immediate parent operation. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L302 |
|
| Guid used in model definition 'UserInfo' for property 'objectId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Watchlists.json#L700 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L290 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isEnabled Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L318 |
️️✔️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":"securityinsights/resource-manager/readme.md",
"tag":"package-2021-03-preview-only",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"securityinsights/resource-manager/readme.md",
"tag":"package-2021-03-preview-only",
"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":"securityinsights/resource-manager/readme.md",
"tag":"package-2021-03-preview-only",
"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).
|
Hi, @laithhisham 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 |
Swagger Generation Artifacts
|
|
[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 @laithhisham, 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. |
This was referenced May 12, 2021
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @laithhisham your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @ArcturusZhang |
This was referenced May 12, 2021
|
@ArcturusZhang We verified the traffic in ARM logs to make sure that these endpoints are not reached and they indeed are. HttpIncomingRequests
|
|
@laithhisham the process requires that any breaking change go through the breaking change approval process described here: https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37684/Breaking-Changes?anchor=process. After the breaking change approval ARM review board will review the API changes. |
laithhisham
changed the title
@filizt Thanks for letting me know. Done, here's the WI: https://msazure.visualstudio.com/One/_workitems/edit/9963295 |
|
Changelog states that the paths being deleted are not being used by customers. Signing off from ARM side. |
filizt
added
ARMSignedOff
|
Hi, @laithhisham. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ghost
added
the
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
approved these changes
Jun 7, 2021
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
ArcturusZhang
added
the
Approved-SdkBreakingChange-Go
This was referenced Jun 8, 2021
asager
pushed a commit
to asager/azure-rest-api-specs
that referenced
this pull request
Jun 24, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
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.