New api version 2021-02-01-preview #12988
Closed
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
|
Hi, @avjerafi 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] |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Since operation 'ListOperations' response has model definition 'x-ms-pageable', 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. Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L43 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L381 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isLegacyLogAnalyticsRule Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L428 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L456 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isWorkspaceAlertsStorageConfigured Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L504 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: checkWorkspaceAlertsStorageConfigured Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L509 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: skipQueryValidation Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L513 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoMitigate Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L517 |
|
| 'actions' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L498 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List scheduled query rules Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L147 |
️️✔️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): 6 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.8.6)
️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 20 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.6)
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/scheduledQueryRules/{ruleName}' removed or restructured? Old: Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json#L37:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/microsoft.insights/scheduledQueryRules' removed or restructured? Old: Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json#L229:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.insights/scheduledQueryRules' removed or restructured? Old: Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json#L272:5 |
|
| The new version is missing a definition that was found in the old version. Was 'LogSearchRuleResource' removed or renamed? New: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L347:3 Old: Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json#L319:3 |
|
| The new version is missing a definition that was found in the old version. Was 'LogSearchRuleResourcePatch' removed or renamed? New: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L347:3 Old: Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json#L319:3 |
|
| The new version is missing a definition that was found in the old version. Was 'Source' removed or renamed? New: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L347:3 Old: Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json#L319:3 |
|
| The new version is missing a definition that was found in the old version. Was 'Schedule' removed or renamed? New: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L347:3 Old: Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json#L319:3 |
|
| The new version is missing a definition that was found in the old version. Was 'QueryType' removed or renamed? New: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L347:3 Old: Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json#L319:3 |
|
| The new version is missing a definition that was found in the old version. Was 'LogSearchRule' removed or renamed? New: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L347:3 Old: Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json#L319:3 |
|
| The new version is missing a definition that was found in the old version. Was 'LogSearchRulePatch' removed or renamed? New: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L347:3 Old: Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json#L319:3 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 10 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'Operation-display' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'OperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'ScheduledQueryRuleProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'ScheduledQueryRuleResourcePatch-tags' with an undefined type and additionalProperties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'ScheduledQueryRuleResourceCollection' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'TrackedResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail." |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @avjerafi, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Feb 15, 2021
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
CI-BreakingChange-Python-Track2
labels
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
The pipeline was completed but result hasn't been updated in PR. Please check latest pipeline result. |
|
/azp run |
|
@avjerafi , Please address the reported Linter error on Operations. |
allenjzhang
reviewed
Feb 21, 2021
| @@ -31,6 +31,15 @@ openapi-type: arm | |||
| tag: package-2020-10 | |||
There was a problem hiding this comment.
Question, are you updating the default tag?
allenjzhang
added
the
WaitForARMFeedback
allenjzhang
reviewed
Feb 21, 2021
| } | ||
| }, | ||
| "x-ms-pageable": { | ||
| "nextLinkName": null |
There was a problem hiding this comment.
nit: if server supports paging, should have nextLinkName. Otherwise, ignore this comment.
There was a problem hiding this comment.
No, the server does not currently support paging
allenjzhang
reviewed
Feb 21, 2021
| "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ResourceGroupNameParameter" |
There was a problem hiding this comment.
nit. I recommend you switch to the common ResourceGroupName parameter which provides standard RegEx validation on client SDK side.
There was a problem hiding this comment.
Applied this recommended change. Thank you.
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
Please go through the contribution checklist added as part of the review and mark them completed. This is a requirement before review can be continued. |
|
Hi, @avjerafi your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @allenjzhang |
|
While adding new version the recommendation is to copy the existing version into new directory structure for first commit and then push new changes for easy review. Please create new branch with this recommendation for faster review. |
|
Submitted an alternate PR #13275, following the recommendation to create a new branch which starts with a clean duplication of the base api version as the 1st commit. |
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.
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.