[Hub Generated] Review request for Microsoft.Insights to add version stable/2023-11-01 #26866
Conversation
This file contains hidden or 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
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| commonMonitoringTypes.json | 2023-11-01(35db80c) | 2021-05-01(main) |
| metricDefinitions_API.json | 2023-11-01(35db80c) | 2021-05-01(main) |
| metricDefinitions_API.json | 2023-11-01(35db80c) | 2017-09-01-preview(main) |
| metrics_API.json | 2023-11-01(35db80c) | 2021-05-01(main) |
| metrics_API.json | 2023-11-01(35db80c) | 2017-09-01-preview(main) |
| operations_API.json | 2023-11-01(35db80c) | 2021-05-01(main) |
| operations_API.json | 2023-11-01(35db80c) | 2017-09-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 4 Errors, 4 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-11 | package-2023-11(35db80c) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/operations_API.json#L79 |
|
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/operations_API.json#L152 |
|
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/operations_API.json#L159 |
|
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/operations_API.json#L243 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-11-01/operations_API.json#L100 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-11-01/operations_API.json#L250 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-11-01/operations_API.json#L272 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-11-01/operations_API.json#L276 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L70 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L112 |
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L244 |
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L255 |
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L328 |
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L339 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L100 |
|
region is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
timespan is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
interval is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
metricnames is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
aggregation is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
top is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
orderby is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
$filter is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
resultType is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
metricnamespace is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
AutoAdjustTimegrain is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
ValidateDimensions is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L121 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L258 |
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L492 |
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L580 |
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L600 |
|
Missing identifier id in array item property Location: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L607 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.Insights/stable/2023-11-01/operations_API.json#L61 |
| The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L7 |
|
| Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L49 |
|
| Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L52 |
|
| Use the latest version v5 of types.json. Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L97 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Insights/stable/2023-11-01/metricDefinitions_API.json#L201 |
️❌Avocado: 48 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/Microsoft.Insights/alertrules/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2016-03-01/alertRules_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/Microsoft.Insights/alertrules is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2016-03-01/alertRules_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/alertrules is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2016-03-01/alertRules_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/Microsoft.Insights/autoscalesettings is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-10-01/autoscale_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/Microsoft.Insights/autoscalesettings/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-10-01/autoscale_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/autoscalesettings is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-10-01/autoscale_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/eventtypes/management/values is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2015-04-01/activityLogs_API.json |
|
The default tag should contain all APIs. The API path /providers/Microsoft.Insights/eventcategories is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2015-04-01/eventCategories_API.json |
|
The default tag should contain all APIs. The API path /providers/Microsoft.Insights/eventtypes/management/values is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/microsoft.insights/alertrules/{}/incidents/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/microsoft.insights/alertrules/{}/incidents is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/logprofiles/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2016-03-01/logProfiles_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/logprofiles is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2016-03-01/logProfiles_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/microsoft.insights/metricDefinitions is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/microsoft.insights/metrics is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2016-09-01/metrics_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/metricAlerts is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2018-03-01/metricAlert_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/metricAlerts is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2018-03-01/metricAlert_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/metricAlerts/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2018-03-01/metricAlert_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/metricAlerts/{}/status is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2018-03-01/metricAlert_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/metricAlerts/{}/status/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2018-03-01/metricAlert_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/scheduledQueryRules is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/metricBaselines is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/activityLogAlerts/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/activityLogAlerts is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/activityLogAlerts is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/dataCollectionEndpoints is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/dataCollectionEndpoints is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/dataCollectionEndpoints/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-06-01/dataCollectionEndpoints_API.json |
|
The default tag should contain all APIs. The API path /{}/providers/Microsoft.Insights/dataCollectionRuleAssociations is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/dataCollectionRules/{}/associations is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/monitor/resource-manager/readme.md json: Microsoft.Insights/stable/2022-06-01/dataCollectionRuleAssociations_API.json |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Object didn't pass validation for format time: 2021-06-08T19:00:00Z/2021-06-12T01:00:00Z Url: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L283:21 ExampleUrl: stable/2023-11-01/examples/PostMultiResourceMetricBody.json |
|
Object didn't pass validation for format duration: FULL Url: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L626:26 ExampleUrl: stable/2023-11-01/examples/GetMetricError.json#L8:17 |
|
Object didn't pass validation for format time: 2021-06-08T19:00:00Z/2021-06-12T01:00:00Z Url: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L283:21 ExampleUrl: stable/2023-11-01/examples/PostMultiResourceMetricBody.json |
|
Object didn't pass validation for format duration: FULL Url: Microsoft.Insights/stable/2023-11-01/metrics_API.json#L626:26 ExampleUrl: stable/2023-11-01/examples/GetMetricError.json#L8:17 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Nov 28, 2023
This was referenced Nov 28, 2023
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.
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
ARMReviewlabel.Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the Diagram Step 2, "ARM API changes Review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.