-
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
Adding new resource type to SecurityInsights - already reviewed/approved in private repo #14499
Adding new resource type to SecurityInsights - already reviewed/approved in private repo #14499
Conversation
Hi, @mpo-sec 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] |
[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, @mpo-sec your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @ |
Swagger Validation Report
|
Rule | Message |
---|---|
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L37:5 |
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json#L100:5 |
️⚠️
LintDiff: 1 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 )
Rule | Message |
---|---|
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 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4018 - OperationsApiResponseSchema |
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#L482 |
|
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#L380 |
|
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#L408 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: customerManagedKey Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L462 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: eyesOn Location: Microsoft.SecurityInsights/preview/2021-03-01-preview/Settings.json#L466 |
️️✔️
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).
Swagger Generation Artifacts
|
NewApiVersionRequired reason: |
.../Microsoft.SecurityInsights/preview/2021-05-01-preview/examples/metadata/DeleteMetadata.json
Outdated
Show resolved
Hide resolved
...nsights/resource-manager/Microsoft.SecurityInsights/preview/2021-05-01-preview/Metadata.json
Outdated
Show resolved
Hide resolved
...nsights/resource-manager/Microsoft.SecurityInsights/preview/2021-03-01-preview/Metadata.json
Outdated
Show resolved
Hide resolved
@mpo-sec Please take a look at the comments and let me know once you update the PR. |
@RamyasreeChakka I have updated the id fields to follow your suggestions. Also I double checked and I have all "kind" fields and not any "type", matching the RPC |
"$ref": "#/definitions/metadataVersion", | ||
"description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks" | ||
}, | ||
"kind": { |
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.
I would recommend to rename 'kind' field as well. Kind is a top-level property in Azure.
Look at the list of top-level properties here
azure-rest-api-specs/specification/common-types/resource-management/v2/types.json
Line 91 in 119d0a9
"ResourceModelWithAllowedPropertySet": { |
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.
Just rename the 'kind' property here. Rest all places should be fine.
RPC mentioned some set of properties. You can refer the full list of top level properties here azure-rest-api-specs/specification/common-types/resource-management/v2/types.json Line 91 in 119d0a9
I am signing off assuming you will make above change. |
…ved in private repo (Azure#14499) * Copy commit from private repo * Make new API version * Remove old examples * Fix exclusion for Metadata list endpoint * Move back to initial preview version * Change id to contentId, sourceId * Fix sourceId in get all example
Was review/approved for ARM and swagger already in private repo: Azure/azure-rest-api-specs-pr#3705
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.