[Hub Generated] Review request for Microsoft.Insights to add version preview/2017-09-01-preview #14104
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
…5-01-preview to version 2017-09-01-preview
|
Hi, @ToddKingMSFT 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
|
Swagger Generation Artifacts
|
|
Hi @ToddKingMSFT, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @akning-ms can I get some help completing this PR? |
|
@kairu-ms Can I get some help completing this PR? |
Go back to the same ErrorResponse the rest of Azure Monitor uses
Go back to the same ErrorResponse the rest of Azure Monitor uses
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Insights/preview/2017-09-01-preview/operations_API.json#L37 |
|
| 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/2017-09-01-preview/operations_API.json#L96 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero Location: Microsoft.Insights/preview/2017-09-01-preview/operations_API.json#L246 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: toBeExportedForShoebox Location: Microsoft.Insights/preview/2017-09-01-preview/operations_API.json#L268 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isHidden Location: Microsoft.Insights/preview/2017-09-01-preview/operations_API.json#L272 |
|
| The API version:2017-09-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Insights/preview/2017-09-01-preview/metricDefinitions_API.json#L5 |
|
| The API version:2017-09-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Insights/preview/2017-09-01-preview/metrics_API.json#L5 |
|
| The API version:2017-09-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Insights/preview/2017-09-01-preview/operations_API.json#L5 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDimensionRequired Location: Microsoft.Insights/preview/2017-09-01-preview/metricDefinitions_API.json#L239 |
️⚠️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-2020-03 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 48 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:preview/2017-09-01-preview/metricDefinitions_API.json compared with base:preview/2017-05-01-preview/metricDefinitions_API.json
- current:preview/2017-09-01-preview/metrics_API.json compared with base:preview/2017-05-01-preview/metrics_API.json
- current:preview/2017-09-01-preview/metricDefinitions_API.json compared with base:stable/2018-01-01/metricDefinitions_API.json
- current:preview/2017-09-01-preview/metrics_API.json compared with base:stable/2018-01-01/metrics_API.json
- current:preview/2017-09-01-preview/operations_API.json compared with base:stable/2015-04-01/operations_API.json
Only 10 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with latest preview version:
Only 10 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
- monitor/resource-manager/readme.md#package-2021-04-only
- monitor/resource-manager/readme.md#package-2021-02-preview-only
- monitor/resource-manager/readme.md#package-2020-10-only
- monitor/resource-manager/readme.md#package-2020-05-preview-only
- monitor/resource-manager/readme.md#package-2020-01-01-preview-only
- monitor/resource-manager/readme.md#package-2020-03
- monitor/resource-manager/readme.md#package-2019-11
- monitor/resource-manager/readme.md#package-2019-10-17-preview-only
- monitor/resource-manager/readme.md#package-2019-06
- monitor/resource-manager/readme.md#package-2019-03
- monitor/resource-manager/readme.md#package-2018-11-preview
- monitor/resource-manager/readme.md#package-2018-09
- monitor/resource-manager/readme.md#package-2018-03
- monitor/resource-manager/readme.md#package-2018-02-preview
- monitor/resource-manager/readme.md#package-2017-12
- monitor/resource-manager/readme.md#package-2017-09
- monitor/resource-manager/readme.md#package-2017-08
- monitor/resource-manager/readme.md#package-2019-11-01-preview-only
- monitor/resource-manager/readme.md#package-2019-06-01-only
- monitor/resource-manager/readme.md#package-2019-03-01-only
- monitor/resource-manager/readme.md#package-2018-11-27-preview-only
- monitor/resource-manager/readme.md#package-2018-09-01-only
- monitor/resource-manager/readme.md#package-2018-06-01-preview-only
- monitor/resource-manager/readme.md#package-2018-04-16-only
- monitor/resource-manager/readme.md#package-2018-03-01-only
- monitor/resource-manager/readme.md#package-2018-01-01-only
- monitor/resource-manager/readme.md#package-2017-12-01-preview-only
- monitor/resource-manager/readme.md#package-2017-11-01-preview-only
- monitor/resource-manager/readme.md#package-2017-05-01-preview-only
- monitor/resource-manager/readme.md#package-2017-04-01-only
- monitor/resource-manager/readme.md#package-2017-03-01-preview-only
- monitor/resource-manager/readme.md#package-2016-09-01-only
- monitor/resource-manager/readme.md#package-2016-03-01-only
- monitor/resource-manager/readme.md#package-2015-07-01-only
- monitor/resource-manager/readme.md#package-2015-04-01-only
- monitor/resource-manager/readme.md#profile-hybrid-2019-03-01
- monitor/resource-manager/readme.md#profile-hybrid-2020-09-01
- monitor/resource-manager/readme.md#package-2017-09-preview-only
|:speech_balloon: AutorestCore/Exception|"readme":"monitor/resource-manager/readme.md",
"tag":"package-2021-04-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-04-only",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"monitor/resource-manager/readme.md",
"tag":"package-2017-09-preview-only",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"monitor/resource-manager/readme.md",
"tag":"package-2017-09-preview-only",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2020-03", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:627", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, properties.etag: undefined => "$ref":"#/components/schemas/schemas:628", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2020-03", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-11", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:648", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, properties.etag: undefined => "$ref":"#/components/schemas/schemas:649", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-11", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-06", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:627", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, properties.etag: undefined => "$ref":"#/components/schemas/schemas:628", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-06", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-03", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:624", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, properties.etag: undefined => "$ref":"#/components/schemas/schemas:625", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-03", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2018-11-preview", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "$ref":"#/components/schemas/schemas:632", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, properties.etag: undefined => "$ref":"#/components/schemas/schemas:633", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2018-11-preview", "details":"Error: Plugin prechecker reported failure." |
️️✔️[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).
Fix new lint errors
Fix lint errors
Fix lint errors
|
Hello @akning-ms / @kairu-ms I've fixed the new lint violations that appeared. The "SDK azure-sdk-for-net" failure is a known issue that has been failing since last last year, I have a separate thread with the DataCollectionRules team on fixing that, I had a review with JeffreyRichter on the "Swagger SDK Breaking Change Tracking" failure and he approved it. |
j5lim
approved these changes
Jun 11, 2021
j5lim
added
ARMSignedOff
This was referenced Jun 11, 2021
asager
pushed a commit
to asager/azure-rest-api-specs
that referenced
this pull request
Jun 24, 2021
…preview/2017-09-01-preview (Azure#14104) * Adds base for updating Microsoft.Insights from version preview/2017-05-01-preview to version 2017-09-01-preview * Updates readme * Updates API version in new specs and examples * Update readme.md * Delete diagnosticsSettingsCategories_API.json * Delete diagnosticsSettings_API.json * Delete subscriptionDiagnosticsSettings_API.json * Delete listSubscriptionDiagnosticSettings.json * Delete listDiagnosticSettingsCategories.json * Delete listDiagnosticSettings.json * Delete getSubscriptionDiagnosticSetting.json * Delete getDiagnosticSettingsCategory.json * Delete getDiagnosticSetting.json * Delete deleteSubscriptionDiagnosticSetting.json * Delete deleteDiagnosticSetting.json * Delete createOrUpdateSubscriptionDiagnosticSetting.json * Delete createOrUpdateDiagnosticSetting.json * Update GetMetric.json * Update GetMetricDefinitions.json * Update GetMetricMetadata.json * Update metricDefinitions_API.json * Update metrics_API.json * Update metrics_API.json Make the Unit description casing consistent to fix lint error * Update metricDefinitions_API.json Make the units enum in metricsDefinitions_API consistent with the one in metrics_API * Add operations API Add operations API * Create operations api example * Update readme.md to include 2017-09-01-preview operations api * Incorporate PR feedback * Update operations_API.json * Update operations_API.json * Update OperationList.json * Update OperationList.json Add error example * Update operations_API.json Add error contract * Update metricDefinitions_API.json Fix lint errors and use standard error response format * Update metrics_API.json Fix lint errors and use standard error response format * Update operations_API.json Fix autorest generation problems * Update operations_API.json * Update readme.md Add suppressions for the error response format * Update metricDefinitions_API.json Go back to the same ErrorResponse the rest of Azure Monitor uses * Update metrics_API.json Go back to the same ErrorResponse the rest of Azure Monitor uses * Update metricDefinitions_API.json Fix new lint errors * Update metrics_API.json Fix lint errors * Update operations_API.json Fix lint errors
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…preview/2017-09-01-preview (Azure#14104) * Adds base for updating Microsoft.Insights from version preview/2017-05-01-preview to version 2017-09-01-preview * Updates readme * Updates API version in new specs and examples * Update readme.md * Delete diagnosticsSettingsCategories_API.json * Delete diagnosticsSettings_API.json * Delete subscriptionDiagnosticsSettings_API.json * Delete listSubscriptionDiagnosticSettings.json * Delete listDiagnosticSettingsCategories.json * Delete listDiagnosticSettings.json * Delete getSubscriptionDiagnosticSetting.json * Delete getDiagnosticSettingsCategory.json * Delete getDiagnosticSetting.json * Delete deleteSubscriptionDiagnosticSetting.json * Delete deleteDiagnosticSetting.json * Delete createOrUpdateSubscriptionDiagnosticSetting.json * Delete createOrUpdateDiagnosticSetting.json * Update GetMetric.json * Update GetMetricDefinitions.json * Update GetMetricMetadata.json * Update metricDefinitions_API.json * Update metrics_API.json * Update metrics_API.json Make the Unit description casing consistent to fix lint error * Update metricDefinitions_API.json Make the units enum in metricsDefinitions_API consistent with the one in metrics_API * Add operations API Add operations API * Create operations api example * Update readme.md to include 2017-09-01-preview operations api * Incorporate PR feedback * Update operations_API.json * Update operations_API.json * Update OperationList.json * Update OperationList.json Add error example * Update operations_API.json Add error contract * Update metricDefinitions_API.json Fix lint errors and use standard error response format * Update metrics_API.json Fix lint errors and use standard error response format * Update operations_API.json Fix autorest generation problems * Update operations_API.json * Update readme.md Add suppressions for the error response format * Update metricDefinitions_API.json Go back to the same ErrorResponse the rest of Azure Monitor uses * Update metrics_API.json Go back to the same ErrorResponse the rest of Azure Monitor uses * Update metricDefinitions_API.json Fix new lint errors * Update metrics_API.json Fix lint errors * Update operations_API.json Fix lint errors
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.
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.