[Hub Generated] Review request for Microsoft.Insights to add version preview/2023-03-01-preview #23613

gulopesd · 2023-04-18T21:24:35Z

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

Link to API Spec engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

Design Document:
Previous API Spec Doc:
Updated paths:

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting
Open API Hub

Guidelines & Specifications

Helpful Links

Azure DevTools Wiki

openapi-pipeline-app · 2023-04-18T21:24:38Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
metricBatch.json	2023-03-01-preview(a6662d7)	2023-03-01-preview(main)

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-preview-2023-03	package-preview-2023-03(a6662d7)	package-preview-2023-03(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L30
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L37
⚠️ ErrorResponse	The `error` property in the error response schema should be required. Location: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L86
⚠️ ErrorResponse	Error schema should define `code` and `message` properties as required. Location: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L86

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/monitor/data-plane/readme.md tag: specification/monitor/data-plane/readme.md#tag-package-preview-2023-03

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️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).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2023-04-18T21:24:38Z

Hi, @gulopesd Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2023-04-18T21:24:39Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Failed [Logs]Release - Generate from 0a37fed. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:671
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 671 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:671
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 671 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to packe sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:759
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 759 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:671
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 671 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.Monitor.Ingestion [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.Monitor.Ingestion.LogsUploadFailedEventArgs' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/monitor/Azure.Monitor.Ingestion/src/Azure.Monitor.Ingestion.csproj::TargetFramework=netstandard2.0],
info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.Monitor.Ingestion.LogsUploadOptions' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/monitor/Azure.Monitor.Ingestion/src/Azure.Monitor.Ingestion.csproj::TargetFramework=netstandard2.0],
info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Microsoft.Extensions.Azure.IngestionClientBuilderExtensions' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/monitor/Azure.Monitor.Ingestion/src/Azure.Monitor.Ingestion.csproj::TargetFramework=netstandard2.0],
info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.Monitor.Ingestion/Debug/netstandard2.0/Azure.Monitor.Ingestion.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/monitor/Azure.Monitor.Ingestion/src/Azure.Monitor.Ingestion.csproj::TargetFramework=netstandard2.0]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-04-18T21:24:40Z

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.Insights	https://apiview.dev/Assemblies/Review/1505e695b9594a48934997d4b3fe482f

mikekistler

Looks good! 👍

mikekistler · 2023-04-19T02:48:16Z

@jhendrixMSFT This PR only changes descriptions so it is good to merge.

ToddKingMSFT · 2023-04-19T18:09:23Z

specification/monitor/data-plane/Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json

@@ -157,7 +157,7 @@
      "in": "query",
      "required": false,
      "type": "string",
-      "description": "The list of aggregation types (comma separated) to retrieve.",
+      "description": "The list of aggregation types (comma separated) to retrieve.\n*Examples: average, minimum, maximum*",


We might as well list count and total here while we're at it.

Small updates to our swagger descriptions and examples

a6662d7

ghost added the Monitor Monitor, Monitor Ingestion, Monitor Query label Apr 18, 2023

AzureRestAPISpecReview added the data-plane label Apr 18, 2023

azure-sdk mentioned this pull request Apr 18, 2023

[AutoPR Azure.Monitor.Ingestion] [Hub Generated] Review request for Microsoft.Insights to add version preview/2023-03-01-preview azure-sdk/azure-sdk-for-net#3606

Closed

gulopesd marked this pull request as ready for review April 18, 2023 22:04

openapi-assignment-bot bot assigned jhendrixMSFT Apr 18, 2023

gulopesd requested a review from mikekistler April 18, 2023 22:04

mikekistler approved these changes Apr 19, 2023

View reviewed changes

jhendrixMSFT merged commit 0a37fed into main Apr 19, 2023

jhendrixMSFT deleted the gulopesd-monitor-Microsoft.Insights-2023-03-01-preview branch April 19, 2023 14:00

azure-sdk mentioned this pull request Apr 19, 2023

[ReleasePR Azure.Monitor.Ingestion] [Monitor.Query] Update Preview Swagger File Azure/azure-sdk-for-net#35533

Closed

ToddKingMSFT reviewed Apr 19, 2023

View reviewed changes

suxi-ms pushed a commit that referenced this pull request Apr 24, 2023

Small updates to our swagger descriptions and examples (#23613)

19b847f

JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023

Small updates to our swagger descriptions and examples (Azure#23613)

eb77bb0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Hub Generated] Review request for Microsoft.Insights to add version preview/2023-03-01-preview #23613

[Hub Generated] Review request for Microsoft.Insights to add version preview/2023-03-01-preview #23613

gulopesd commented Apr 18, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

openapi-workflow-bot bot commented Apr 18, 2023

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

mikekistler left a comment

mikekistler commented Apr 19, 2023

ToddKingMSFT Apr 19, 2023

[Hub Generated] Review request for Microsoft.Insights to add version preview/2023-03-01-preview #23613

[Hub Generated] Review request for Microsoft.Insights to add version preview/2023-03-01-preview #23613

Conversation

gulopesd commented Apr 18, 2023 • edited Loading

Data Plane API - Pull Request

API Info: The Basics

Change Scope

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

openapi-pipeline-app bot commented Apr 18, 2023 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Apr 18, 2023

openapi-pipeline-app bot commented Apr 18, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Apr 18, 2023 • edited Loading

Generated ApiView

mikekistler left a comment

Choose a reason for hiding this comment

mikekistler commented Apr 19, 2023

ToddKingMSFT Apr 19, 2023

Choose a reason for hiding this comment

gulopesd commented Apr 18, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading

openapi-pipeline-app bot commented Apr 18, 2023 •

edited

Loading