Logz/metrcis new version #17268
Merged
Logz/metrcis new version #17268
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, @banggaurav 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 |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The required parameter 'api-version' was added in the new version. New: Microsoft.Logz/preview/2020-10-01-preview/logz.json#L87:9 |
|
The required parameter 'api-version' was added in the new version. New: Microsoft.Logz/stable/2020-10-01/logz.json#L87:9 |
️⚠️LintDiff: 18 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2602 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2682 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2859 |
|
| The operation 'MetricsSourceTagRules_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L1961 |
|
| The child tracked resource, 'metricsSource' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2531 |
|
| The child tracked resource, 'tagRules' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2834 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: sendMetrics Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2788 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L1596 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L1763 |
|
| 'ruleSetName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L1872 |
|
| 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L1878 |
|
| 'ruleSetName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L1931 |
|
| 'ruleSetName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L1983 |
|
| 'LogzMetricsResource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2575 |
|
| 'tags' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2608 |
|
| 'location' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2614 |
|
| 'metricRules' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2792 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: TagRules_Delete Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2016 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Per the Noun_Verb convention for Operation Ids, the noun 'Monitors' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Logz/stable/2020-10-01/logz.json#L35 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'Monitors' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L35 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'Monitors' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Logz/preview/2020-10-01-preview/logz.json#L35 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/stable/2020-10-01/logz.json#L2053 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/stable/2020-10-01/logz.json#L2100 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/stable/2020-10-01/logz.json#L2206 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/stable/2020-10-01/logz.json#L2283 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2558 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2666 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2829 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2953 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2020-10-01-preview/logz.json#L2053 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2020-10-01-preview/logz.json#L2100 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2020-10-01-preview/logz.json#L2206 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Logz/preview/2020-10-01-preview/logz.json#L2283 |
|
| The operation 'TagRules_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Logz/stable/2020-10-01/logz.json#L577 |
|
| The operation 'SubAccountTagRules_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Logz/stable/2020-10-01/logz.json#L1247 |
|
| The operation 'TagRules_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L577 |
|
| The operation 'SubAccountTagRules_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L1247 |
|
| The operation 'TagRules_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Logz/preview/2020-10-01-preview/logz.json#L577 |
|
| The operation 'SubAccountTagRules_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.Logz/preview/2020-10-01-preview/logz.json#L1247 |
|
| The child tracked resource, 'tagRules' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/stable/2020-10-01/logz.json#L2181 |
|
| The child tracked resource, 'singleSignOnConfigurations' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/stable/2020-10-01/logz.json#L2261 |
|
| The child tracked resource, 'accounts' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/stable/2020-10-01/logz.json#L2026 |
|
| The child tracked resource, 'tagRules' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/stable/2020-10-01/logz.json#L2181 |
|
| The child tracked resource, 'tagRules' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2804 |
|
| The child tracked resource, 'singleSignOnConfigurations' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2931 |
|
| The child tracked resource, 'accounts' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2531 |
|
| The child tracked resource, 'tagRules' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L2804 |
|
| The child tracked resource, 'tagRules' with immediate parent 'LogzMonitorResource', must have a list by immediate parent operation. Location: Microsoft.Logz/preview/2020-10-01-preview/logz.json#L2181 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 1 Errors, 1 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.1)
- current:preview/2022-01-01-preview/logz.json compared with base:stable/2020-10-01/logz.json
- current:preview/2022-01-01-preview/logz.json compared with base:preview/2020-10-01-preview/logz.json
| Rule | Message |
|---|---|
|
The required parameter 'api-version' was added in the new version. New: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L87:9 |
The following breaking changes are detected by comparison with latest preview version:
| Rule | Message |
|---|---|
| The required parameter 'api-version' was added in the new version. New: Microsoft.Logz/preview/2022-01-01-preview/logz.json#L87:9 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
|
[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 Generation Artifacts
|
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @banggaurav your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
Hi @banggaurav, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Jan 6, 2022
Closed
added 3 commits
January 7, 2022 00:46
ruowan
reviewed
Jan 7, 2022
| } | ||
| } | ||
| }, | ||
| "/providers/Microsoft.Logz/operations": { |
There was a problem hiding this comment.
Seems should add api-version parameters in this path.
|
Hi @banggaurav, 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. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
JeffreyRichter
added
the
Approved-BreakingChange
jorgecotillo
added
ARMSignedOff
|
@ruowan @zhenglaizhang Can you please review this PR? |
ruowan
approved these changes
Jan 17, 2022
|
LGTM. Ready to merge? |
|
@ruowan Yes we can merge these. |
This was referenced Jan 18, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Jan 18, 2022
mstrisoline
pushed a commit
to mstrisoline/azure-rest-api-specs
that referenced
this pull request
Feb 1, 2022
* adding new api version * updating version and adding new apis * adding apis * swagger fixes * prettier fix * adding api version for operations api * adding api versions param for operatiosn for previous and stable version Co-authored-by: Gaurav Bang <gauravbang@microsoft.com>
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
* adding new api version * updating version and adding new apis * adding apis * swagger fixes * prettier fix * adding api version for operations api * adding api versions param for operatiosn for previous and stable version Co-authored-by: Gaurav Bang <gauravbang@microsoft.com>
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
Add a changelog entry for 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
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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 any of the following scenarios apply to the PR, request approval from the 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.