-
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
Commint new examples and paths #11875
Conversation
Swagger Validation Report
|
Rule | Message |
---|---|
Since operation 'Entities_Queries' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L2205 |
|
Since operation 'Entities_GetInsights' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L2256 |
|
'GET' operation 'Entities_Queries' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L2205 |
|
Consider using x-ms-client-flatten to provide a better end user experience New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L6905 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: kind New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L10928 |
|
Based on the response model schema, operation 'Entities_Queries' might be pageable. Consider adding the x-ms-pageable extension. New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L2195 |
|
Guid used in model definition 'EntityQueryItem' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L10959 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: addDefaultExtendedTimeRange New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L10869 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
Thank you for your contribution shschwar! We will review the pull request and get back to you soon. |
NewApiVersionRequired reason: |
...resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
Outdated
Show resolved
Hide resolved
add |
...resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
Show resolved
Hide resolved
...ager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetQueries.json
Outdated
Show resolved
Hide resolved
...resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
Outdated
Show resolved
Hide resolved
...resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
Outdated
Show resolved
Hide resolved
...ager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetQueries.json
Outdated
Show resolved
Hide resolved
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.
Approving from ARM side. For breaking changes, there is a process we need to follow. Please check Breaking Change Review Checklist in the pr description and get an approval for breaking changes.
hi @shschwar could you pls follow the guideline to create the ADO item for breaking change review? thanks |
...resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
Show resolved
Hide resolved
hi @ArcturusZhang could you pls help to look at |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
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.
A typo in enum name is breaking SDK generation, please fix, thanks
...resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
Outdated
Show resolved
Hide resolved
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.
LGTM now
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 API 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.