-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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] Review request for Microsoft.Insights to add version stable/2019-07-01 #14082
[Hub Generated] Review request for Microsoft.Insights to add version stable/2019-07-01 #14082
Conversation
…-01 to version 2019-07-01
We are not introducing a new version of metricDefinitions for API version 2019-07-01
No new metric definitions API for 2019-07-01
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 |
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/stable/2019-07-01/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/stable/2019-07-01/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/stable/2019-07-01/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/stable/2019-07-01/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/stable/2019-07-01/operations_API.json#L272 |
️⚠️
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: 23 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:stable/2019-07-01/metrics_API.json compared with base:preview/2017-05-01-preview/metrics_API.json
- current:stable/2019-07-01/metrics_API.json compared with base:stable/2018-01-01/metrics_API.json
- current:stable/2019-07-01/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-2019-07-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-2019-07-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-2019-07-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 |
---|---|
PreCheck/DuplicateSchema |
"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." |
AutorestCore/Exception |
"readme":"monitor/resource-manager/readme.md", "tag":"package-2020-03", "details":"Error: Plugin prechecker reported failure." |
PreCheck/DuplicateSchema |
"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." |
AutorestCore/Exception |
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-11", "details":"Error: Plugin prechecker reported failure." |
PreCheck/DuplicateSchema |
"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." |
AutorestCore/Exception |
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-06", "details":"Error: Plugin prechecker reported failure." |
PreCheck/DuplicateSchema |
"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." |
AutorestCore/Exception |
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-03", "details":"Error: Plugin prechecker reported failure." |
PreCheck/DuplicateSchema |
"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." |
AutorestCore/Exception |
"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).
Swagger Generation Artifacts
|
[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. |
Hi @ToddKingMSFT, Your PR has some issues. Please fix the CI sequentially by following the order of
|
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
Hi, @ToddKingMSFT. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Add error message field and example and make displayDescription optional
Fix lint errors
Fix lint errors
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@ToddKingMSFT Please fix LintDiff (and other required CIs) |
Go back to the common ErrorResponse for Azure Monitor
Fix SDK generation errors by using same ErrorResponse object as rest of Azure Monitor
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
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. |
…stable/2019-07-01 (Azure#14082) * Adds base for updating Microsoft.Insights from version stable/2018-01-01 to version 2019-07-01 * Updates readme * Updates API version in new specs and examples * Delete 2019-07-01 metricDefinitions_API.json We are not introducing a new version of metricDefinitions for API version 2019-07-01 * Delete GetMetricDefinitions.json No new metric definitions API for 2019-07-01 * Update 2019-07-01 metrics example * Update 2019-07-01 metric metadata example * Update 2019-07-01 metrics API with updates from 2018-01-01 * Remove 2019-07-01 metric definitions API from readme * Update readme.md Fix package tag and add error response schema suppression * Update metrics_API.json Fix lint and spelling issues * Update GetMetric.json Fix spelling issues * Create operations_API.json * Create OperationList.json * Create GetMetricError.json Add example that shows an error message being returned for one of the metrics * Update GetMetricError.json Remove displayDescription example * Update metrics_API.json Add error message field and example and make displayDescription optional * Update operations_API.json Fix lint errors * Update metrics_API.json Fix lint errors * Update metrics_API.json Go back to the common ErrorResponse for Azure Monitor * Update operations_API.json Fix SDK generation errors by using same ErrorResponse object as rest of Azure Monitor
…stable/2019-07-01 (Azure#14082) * Adds base for updating Microsoft.Insights from version stable/2018-01-01 to version 2019-07-01 * Updates readme * Updates API version in new specs and examples * Delete 2019-07-01 metricDefinitions_API.json We are not introducing a new version of metricDefinitions for API version 2019-07-01 * Delete GetMetricDefinitions.json No new metric definitions API for 2019-07-01 * Update 2019-07-01 metrics example * Update 2019-07-01 metric metadata example * Update 2019-07-01 metrics API with updates from 2018-01-01 * Remove 2019-07-01 metric definitions API from readme * Update readme.md Fix package tag and add error response schema suppression * Update metrics_API.json Fix lint and spelling issues * Update GetMetric.json Fix spelling issues * Create operations_API.json * Create OperationList.json * Create GetMetricError.json Add example that shows an error message being returned for one of the metrics * Update GetMetricError.json Remove displayDescription example * Update metrics_API.json Add error message field and example and make displayDescription optional * Update operations_API.json Fix lint errors * Update metrics_API.json Fix lint errors * Update metrics_API.json Go back to the common ErrorResponse for Azure Monitor * Update operations_API.json Fix SDK generation errors by using same ErrorResponse object as rest of Azure Monitor
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.