Data Plane API - Pull Request

We're onboarding the Application Insights QuickPulse feature for the OpenTelemetry customers, so we need to formalize the swagger file for the SDK client of different languages to refer to the same definitions of QuickPulse client behavior.

Jan 18 '24 01:01 benke520

Next Steps to Merge

✅ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

Jan 18 '24 01:01 openapi-pipeline-app[bot]

Swagger Validation Report

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

There are no breaking changes.

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 11 Warnings warning [Detail]

Compared specs (v2.2.0)	new version	base version
2024-04-01-preview	2024-04-01-preview(da86fab)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
:warning: SecurityDefinitionDescription	Security definition should have a description. Location: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L44
:warning: OperationId	OperationId should be of the form 'Noun_Verb' Location: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L57
:warning: RequestBodyOptional	The body parameter is not marked as required. Location: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L87
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L116
:warning: ErrorResponse	Error response schema should contain an object property named `error`. Location: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L118
:warning: OperationId	OperationId should be of the form 'Noun_Verb' Location: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L132
:warning: RequestBodyOptional	The body parameter is not marked as required. Location: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L147
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L168
:warning: ErrorResponse	Error response schema should contain an object property named `error`. Location: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L170
:warning: EnumInsteadOfBoolean	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: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L697
:warning: EnumInsteadOfBoolean	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: LiveMetrics/preview/2024-04-01-preview/livemetrics.json#L701

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

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

️️✔️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]

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

Jan 18 '24 01:01 openapi-pipeline-app[bot]

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-python failed [Detail]

❌Code Generator Failed [Logs] Generate from 173d7dffc82318e73918a50e9e082d54ac991836. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
warn		specification/applicationinsights/data-plane/LiveMetrics/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh]  New minor version of npm available! 10.2.4 -> 10.5.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice
cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
warn	Skip package processing as generation is failed

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

❌Pipeline Framework Failed [Logs] Generate from 173d7dffc82318e73918a50e9e082d54ac991836. 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
warn		specification/applicationinsights/data-plane/LiveMetrics/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
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]
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Run `npm install -g [email protected]` to update!
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice
cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1mWrite-Error: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:120[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[0m[36;1mLine |[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[0m[36;1m[36;1m 120 | [0m … ectFolder = [36;1m& $processScript $typespecFolder $commitid $repoHttpsUrl [0m …[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[0m[36;1m[36;1m[0m[36;1m[0m[36;1m     | [31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[0m[36;1m[36;1m[0m[36;1m[0m[36;1m[31;1m[31;1m[36;1m     | [31;1mFailed to generate sdk project at[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[0m[36;1m[36;1m[0m[36;1m[0m[36;1m[31;1m[31;1m[36;1m[31;1m[36;1m     | [31;1m/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/applicationinsights.livemetrics/LiveMetrics[0m
fatal: 'sdkAuto/27430/' is not a valid branch name

❌ [View full logs]

error	Fatal error: fatal: 'sdkAuto/27430/' is not a valid branch name
error	Fatal error: Error: fatal: 'sdkAuto/27430/' is not a valid branch name    at Object.action (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1332:25)    at PluginStore.exec (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1367:29)    at /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1766:43    at new Promise (<anonymous>)    at GitExecutorChain.handleTaskData (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1764:16)    at GitExecutorChain.<anonymous> (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:1748:44)    at Generator.next (<anonymous>)    at fulfilled (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected]/node_modules/simple-git/dist/cjs/index.js:55:24)    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
error	The following packages are still pending:
error

️🔄 azure-sdk-for-js inProgress [Detail]

️❌ azure-sdk-for-java failed [Detail]

❌Pipeline Framework Failed [Logs] Generate from 173d7dffc82318e73918a50e9e082d54ac991836. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] e     Time  Current
cmderr	[init.sh]                                  Dload  Upload   Total   Spent    Left  Speed
cmderr	[init.sh] 
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0-:--:-- --:--:-- --:--:--  136k
cmderr	[init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz...
cmderr	[init.sh] Computing checksum with sha256sum
cmderr	[init.sh] Checksums matched!
warn		specification/applicationinsights/data-plane/LiveMetrics/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] notice
cmderr	[generate.py] npm notice New major version of npm available! 9.5.0 -> 10.5.0
cmderr	[generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
cmderr	[generate.py] npm notice Run `npm install -g [email protected]` to update!
cmderr	[generate.py] npm notice
cmderr	[generate.py] [31;1mWrite-Error: [31;1mFailed to generate sdk project at /mnt/vss/_work/1/s/azure-sdk-for-java/sdk/applicationinsights.livemetrics/livemetrics[0m
error	Fatal error: The "path" argument must be of type string. Received undefined
The "path" argument must be of type string. Received undefined
error	Fatal error: TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined    at new NodeError (node:internal/errors:405:5)    at validateString (node:internal/validators:162:11)    at Object.basename (node:path:1308:5)    at getPackageData (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/types/PackageData.js:45:82)    at /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:222:213    at Array.map (<anonymous>)    at workflowHandleReadmeMdOrTypeSpecProject (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:222:164)    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)    at async workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:109:13)    at async sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:215:13)    at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18

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

Jan 18 '24 01:01 openapi-pipeline-app[bot]

Generated ApiView

Language	Package Name	ApiView Link
TypeSpec	ApplicationInsights.LiveMetrics	https://apiview.dev/Assemblies/Review/368f15cf9ab8441aa98434bdb9339551?revisionId=afe851601bd54413a4a5bc5a0a92677e
Swagger	LiveMetrics	https://apiview.dev/Assemblies/Review/6f841de416dc4477af5dcefb013ee959?revisionId=dd2ca663e2de4034b16b8f00f5af40c5

Jan 18 '24 01:01 openapi-pipeline-app[bot]

Hi @benke520! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

Jan 18 '24 01:01 openapi-workflow-bot[bot]

Swagger Generation Artifacts

️⌛ApiDocPreview pending [Detail]

️⌛SDK Breaking Change Tracking pending [Detail]

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

Feb 20 '24 20:02 openapi-pipeline-app[bot]

Swagger Validation Report

️⌛BreakingChange pending [Detail]

️⌛Breaking Change(Cross-Version) pending [Detail]

️⌛CredScan pending [Detail]

️🔄LintDiff inProgress [Detail]

️🔄Avocado inProgress [Detail]

️⌛SwaggerAPIView pending [Detail]

️⌛TypeSpecAPIView pending [Detail]

️⌛ModelValidation pending [Detail]

️⌛SemanticValidation pending [Detail]

️⌛PoliCheck pending [Detail]

️⌛SpellCheck pending [Detail]

️⌛Lint(RPaaS) pending [Detail]

️⌛PR Summary pending [Detail]

️⌛Automated merging requirements met pending [Detail]

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

Feb 20 '24 20:02 openapi-pipeline-app[bot]

Swagger Validation Report

️⌛BreakingChange pending [Detail]

️⌛Breaking Change(Cross-Version) pending [Detail]

️⌛CredScan pending [Detail]

️🔄LintDiff inProgress [Detail]

️🔄Avocado inProgress [Detail]

️🔄SwaggerAPIView inProgress [Detail]

️🔄TypeSpecAPIView inProgress [Detail]

️⌛ModelValidation pending [Detail]

️⌛SemanticValidation pending [Detail]

️⌛PoliCheck pending [Detail]

️🔄SpellCheck inProgress [Detail]

️🔄Lint(RPaaS) inProgress [Detail]

️⌛PR Summary pending [Detail]

️⌛Automated merging requirements met pending [Detail]

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

Feb 20 '24 20:02 openapi-pipeline-app[bot]

Swagger Validation Report

️⌛BreakingChange pending [Detail]

️🔄Breaking Change(Cross-Version) inProgress [Detail]

️⌛CredScan pending [Detail]

️🔄LintDiff inProgress [Detail]

️❌Avocado: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` NO_JSON_FILE_FOUND	The JSON file is not found but it is referenced from the readme file. readme: applicationinsights/data-plane/Monitor.Exporters/readme.md json: Monitor.Exporters/preview/v2.1/swagger-livemetrics.json

️🔄SwaggerAPIView inProgress [Detail]

️🔄TypeSpecAPIView inProgress [Detail]

️⌛ModelValidation pending [Detail]

️🔄SemanticValidation inProgress [Detail]

️⌛PoliCheck pending [Detail]

️🔄SpellCheck inProgress [Detail]

️🔄Lint(RPaaS) inProgress [Detail]

️⌛PR Summary pending [Detail]

️⌛Automated merging requirements met pending [Detail]

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

Feb 20 '24 20:02 openapi-pipeline-app[bot]

Swagger Generation Artifacts

️⌛ApiDocPreview pending [Detail]

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

Breaking Changes Tracking

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

Feb 20 '24 20:02 openapi-pipeline-app[bot]

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

Mar 04 '24 19:03 openapi-pipeline-app[bot]

/pr RequestMerge

Mar 12 '24 19:03 benke520

Provide QuickPulse swagger for Azure Monitor

Data Plane API - Pull Request

Next Steps to Merge

Swagger Validation Report

Swagger Generation Artifacts

Breaking Changes Tracking

Generated ApiView

Swagger Generation Artifacts

Swagger Validation Report

Swagger Validation Report

Swagger Validation Report

Swagger Generation Artifacts

Breaking Changes Tracking