-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
[Hub Generated] Public private branch 'dev-monitor-Microsoft.Insights-2021-02-01-preview-webHookProperties' #14865
Conversation
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. vsswagger@microsoft.com |
[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. |
Swagger Validation Report
|
Rule | Message |
---|---|
AutoRest exception |
"readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"openapi-document/openapi-document-converter - FAILED" |
AutoRest exception |
"readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Error: Invalid reference token: ResourceGroupNameParameter" |
AutoRest exception |
"readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Failed validating: 'swagger-document', error encountered: TypeError: Cannot read property 'value' of undefined" |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R3023 - OperationsAPIImplementation |
Operations API must be implemented for '/providers/Microsoft.Insights/operations'. Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L36 |
R4037 - MissingTypeObject |
The schema 'ScheduledQueryRuleProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L333 |
R4037 - MissingTypeObject |
The schema 'tags' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L486 |
R4037 - MissingTypeObject |
The schema 'ScheduledQueryRuleResourceCollection' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Insights/preview/2021-02-01-preview/scheduledQueryRule_API.json#L500 |
AutoRest exception |
"readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"openapi-document/openapi-document-converter - FAILED" |
AutoRest exception |
"readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Error: Invalid reference token: ResourceGroupNameParameter" |
AutoRest exception |
"readme":"monitor/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Failed validating: 'swagger-document', error encountered: TypeError: Cannot read property 'value' of undefined" |
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#L340 |
|
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#L368 |
|
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#L417 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-2021-04 |
️️✔️
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":"monitor/resource-manager/readme.md",
"tag":"package-2021-02-preview-only",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"monitor/resource-manager/readme.md",
"tag":"package-2021-02-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":"monitor/resource-manager/readme.md",
"tag":"package-2021-02-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: |
Hi @avjerafi, 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. |
@weidongxu-microsoft Looking at master, it seems that ResourceGroupNameParameter is defined and that the reference path is correct: azure-rest-api-specs/specification/common-types/resource-management/v2/types.json Line 657 in 5ffa6f9
Am I wrong? |
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.
@jianyexi Any idea what the LintDiff means? LintDiff passes in private repo. And there appears no change to ResourceGroupNameParameter
in this PR.
@@ -3764,7 +3764,7 @@ | |||
"requires": { |
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.
revert this file if not needed.
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.
@weidongxu-microsoft
I'm failing to submit my fixes. Can you please help me out?
I cloned this repo and made changes in my "copied-from-private" branch, but cannot push them:
remote: error: GH006: Protected branch update failed for refs/heads/copied-from-private/avjerafi/azure-rest-api-specs-pr/dev-monitor-Microsoft.Insights-2021-02-01-preview-webHookProperties.
remote: error: You're not authorized to push to this branch. Visit https://docs.github.com/articles/about-protected-branches/ for more information.
I'm not all familiar with the private+public flow and the documentation I've found does not clarify what steps I need to take in this scenario.
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.
That is the reason I asked you to fix in the private repo PR in the first place...
Since the copied-from-private
is on Azure repo (not your cloned repo), you probably not able to modify it.
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.
Sorry, I cannot modify this branch (surprise to me).
You will have to make another branch on your repo (based on this), and make changes on that branch, and send a new PR.
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.
Generally, if you do not have any secret changes that does not want non-MSFT to see, you do not need to use the private repo in the first place.
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.
Thanks for the input.
If the copied-from-private
branch is unmodifiable, what am I to do in the current situation where there are discrepancies between the validation outcome in the private vs. the public repo?
I only moved to the public repo because I was under the impression that there will be no fixes required.
- The changes in the
package-lock
file were solely made by runningprettier
. - The usage of
ResourceGroupNameParameter
passed validation in the private repo.
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.
You will have to make another branch on your repo (based on this), and make changes on that branch, and send a new PR.
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.
Got it. I'll do that. Thanks.
What will I have to modify in that new branch so that the ResourceGroupNameParameter
reference will pass validation?
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.
Not sure.
Maybe in the new branch, you can try merge the new changes from master (which include the directive).
If it still not work, you might try delete the following directive from readme.md
- from: scheduledQueryRule_API.json
where: $.parameters
transform: delete $["ResourceGroupNameParameter"]
reason: ResourceGroupNameParameter is taken from v2/types.json
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Caused by below directive in readme.md, not sure why it exists
|
@weidongxu-microsoft
Thanks! |
@weidongxu-microsoft |
This PR moves the private branch that was created into public. The branch has already been reviewed, to view the status, please go to the OpenAPI Hub.