[Hub Generated] Review request for Microsoft.SecurityInsights to add version preview/2019-01-01-preview #11795
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 pipeline can not start as the pull request has merge conflicts. |
1 similar comment
|
Swagger pipeline can not start as the pull request has merge conflicts. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WatchlistItemModel'. Consider using the plural form of 'WatchlistItem' to avoid this. 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#L3788 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WatchlistItemModel'. Consider using the plural form of 'WatchlistItem' to avoid this. 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#L3837 |
|
| The child tracked resource, 'watchlistItems' with immediate parent 'Watchlist', must have a list by immediate parent operation. New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L4345 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDeleted New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L10251 |
️️✔️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
|
This was referenced Nov 24, 2020
This was referenced Nov 24, 2020
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
hassanchawiche
added
the
WaitForARMFeedback
|
Hi, @hassanchawiche 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 |
|
Hi, @hassanchawiche your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @PhoenixHe-msft |
filizt
reviewed
Nov 24, 2020
| "$ref": "#/parameters/WatchlistItem" | ||
| } | ||
| ], | ||
| "responses": { |
There was a problem hiding this comment.
Is the PUT a long running operation here?
There was a problem hiding this comment.
No, it's not
majastrz
reviewed
Nov 25, 2020
| @@ -3774,6 +3774,115 @@ | |||
| } | |||
| } | |||
| }, | |||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItem/{watchlistItemId}": { | |||
There was a problem hiding this comment.
watchlistItem [](start = 212, length = 13)
Resource type names in ARM are plural by convention. Also watchlistItems is kind of redundant since it's nested under a watchlists resource type. Can you rename to watchlistItems or just items?
Also, you are missing the API to list all watchlistItems in a watchlist.
There was a problem hiding this comment.
Changed to WatchlistItems.
Getting all WatchlistItems endpoint will be added in future change.
There was a problem hiding this comment.
@majastrz : could you pls review my pr ?
|
This pull request is modifying the I think you have the following options:
|
majastrz
added
ARMChangesRequested
|
Hi @hassanchawiche, 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: |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
@hassanchawiche Please fix avocado issue. |
hassanchawiche
added
WaitForARMFeedback
@PhoenixHe-msft : Avocado issues have been resolved. It turned out to be a file encoding issue rather than a json content error. |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
hassanchawiche
removed
the
ARMChangesRequested
majastrz
added
ARMSignedOff
This was referenced Jan 7, 2021
Merged
hassanchawiche
deleted the
hc-dev-securityinsights-Microsoft.SecurityInsights-2019-01-01-preview
branch
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.
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.
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.
Please follow the link to find more details on PR review process.