[policheck] fix swagger examples for applicationinsights service #19713

JackTn · 2022-07-08T07:34:41Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

openapi-workflow-bot · 2022-07-08T07:34:44Z

Hi, @JackTn 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 · 2022-07-08T07:34:46Z

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 succeeded [Detail] [Expand]

Validation passes for LintDiff.

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/applicationinsights/resource-manager/readme.md tag: specification/applicationinsights/resource-manager/readme.md#tag-package-2022-06-15

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

️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` unacceptable kind of an object to dump [object Error]	"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/f4dd4962632f9a78b06227f81de3135cfd22b38b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/swagger.json"
`❌` unacceptable kind of an object to dump [object Error]	"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/f4dd4962632f9a78b06227f81de3135cfd22b38b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/AppInsights.json"

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

Validation passes for SemanticValidation.

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

Validation passed for PoliCheck.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

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

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

openapi-pipeline-app · 2022-07-08T07:34:46Z

Swagger Generation Artifacts

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

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

Breaking Changes Tracking

️✔️azure-sdk-for-go - armapplicationinsights - 2.0.0-beta.2

️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-applicationinsights - 3.1.0

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

❌Failed [Logs]Release - Generate from 5d33edc. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
warn		specification/applicationinsights/data-plane/readme.md skipped due to azure-sdk-for-net not found in swagger-to-sdk
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/applicationinsights/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] No usable version of the libssl was found
cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
warn	Skip package processing as generation is failed

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 5d33edc. 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: Skipping azure-nspkg as it is not installed.
warn		specification/applicationinsights/data-plane/readme.md skipped due to azure-sdk-for-python-track2 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]  global `--global`, `--local` are deprecated. Use `--location=global` instead.

️✔️track2_azure-mgmt-applicationinsights [View full logs] [Release SDK Changes]
- azure_mgmt_applicationinsights-3.1.0-py3-none-any.whl
- azure-mgmt-applicationinsights-3.1.0.zip
```
info	[Changelog]
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 5d33edc. 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
warn		specification/applicationinsights/data-plane/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
warn	No file changes detected after generation
warn	No package detected after generation

️✔️azure-resourcemanager-applicationinsights [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 5d33edc. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
warn		specification/applicationinsights/data-plane/readme.md skipped due to azure-sdk-for-go not found in swagger-to-sdk
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️armapplicationinsights [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `*WorkbookTemplatesClient.Update` parameter(s) have been changed from `(context.Context, string, string, *WorkbookTemplatesClientUpdateOptions)` to `(context.Context, string, string, WorkbookTemplateUpdateParameters, *WorkbookTemplatesClientUpdateOptions)`
info	[Changelog] - Function `*WorkbooksClient.Update` parameter(s) have been changed from `(context.Context, string, string, *WorkbooksClientUpdateOptions)` to `(context.Context, string, string, WorkbookUpdateParameters, *WorkbooksClientUpdateOptions)`
info	[Changelog] - Field `WorkbookUpdateParameters` of struct `WorkbooksClientUpdateOptions` has been removed
info	[Changelog] - Field `WorkbookTemplateUpdateParameters` of struct `WorkbookTemplatesClientUpdateOptions` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `WebTestKindStandard`
info	[Changelog] - New function `*OperationsClient.NewListPager(*OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]`
info	[Changelog] - New function `NewOperationsClient(azcore.TokenCredential, *arm.ClientOptions) (*OperationsClient, error)`
info	[Changelog] - New struct `ErrorFieldContract`
info	[Changelog] - New struct `HeaderField`
info	[Changelog] - New struct `OperationsClient`
info	[Changelog] - New struct `OperationsClientListOptions`
info	[Changelog] - New struct `OperationsClientListResponse`
info	[Changelog] - New struct `WebTestPropertiesRequest`
info	[Changelog] - New struct `WebTestPropertiesValidationRules`
info	[Changelog] - New struct `WebTestPropertiesValidationRulesContentValidation`
info	[Changelog] - New field `Request` in struct `WebTestProperties`
info	[Changelog] - New field `ValidationRules` in struct `WebTestProperties`
info	[Changelog] - New field `Details` in struct `ErrorResponse`
info	[Changelog]
info	[Changelog] Total 4 breaking change(s), 21 additive change(s).

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

❌Failed [Logs]Release - Generate from 5d33edc. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
cmderr	[automation_init.sh] deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh]  deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh]  @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] WARN deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
warn		specification/applicationinsights/data-plane/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js]: sh .scripts/automation_generate.sh
warn	Skip package processing as generation is failed
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-appinsights [View full logs] [Release SDK Changes]
- azure-arm-appinsights-5.0.0-beta.5.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 5d33edc. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
warn		specification/applicationinsights/data-plane/readme.md skipped due to azure-resource-manager-schemas not found in swagger-to-sdk
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation
warn	Skip detect changed packages

️✔️applicationinsights [View full logs]

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 5d33edc. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
warn		specification/applicationinsights/data-plane/readme.md skipped due to azure-powershell not found in swagger-to-sdk
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

️✔️Az.ApplicationInsights [View full logs] [Release SDK Changes]
- Az.ApplicationInsights.0.1.0.nupkg

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

ruowan · 2022-07-12T05:09:15Z

/azp run

azure-pipelines · 2022-07-12T05:09:24Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-workflow-bot · 2022-07-12T05:11:34Z

Hi @JackTn, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

fix policheck

f4dd496

JackTn requested a review from a team as a code owner July 8, 2022 07:34

JackTn requested review from tg-msft and bexxx and removed request for a team July 8, 2022 07:34

openapi-assignment-bot bot assigned tjprescott Jul 8, 2022

azure-sdk mentioned this pull request Jul 8, 2022

[AutoPR armapplicationinsights] [policheck] fix swagger examples for applicationinsights service azure-sdk/azure-sdk-for-go#1683

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jul 8, 2022

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jul 12, 2022

tjprescott approved these changes Jul 15, 2022

View reviewed changes

tjprescott added the Approved-ModelValidation label Jul 15, 2022

tjprescott merged commit 5d33edc into Azure:main Jul 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[policheck] fix swagger examples for applicationinsights service #19713

[policheck] fix swagger examples for applicationinsights service #19713

JackTn commented Jul 8, 2022

openapi-workflow-bot bot commented Jul 8, 2022

openapi-pipeline-app bot commented Jul 8, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2022 •

edited

Loading

Breaking Changes Tracking

ruowan commented Jul 12, 2022

azure-pipelines bot commented Jul 12, 2022

openapi-workflow-bot bot commented Jul 12, 2022

[policheck] fix swagger examples for applicationinsights service #19713

[policheck] fix swagger examples for applicationinsights service #19713

Conversation

JackTn commented Jul 8, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jul 8, 2022

openapi-pipeline-app bot commented Jul 8, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jul 8, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

ruowan commented Jul 12, 2022

azure-pipelines bot commented Jul 12, 2022

openapi-workflow-bot bot commented Jul 12, 2022

openapi-pipeline-app bot commented Jul 8, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 8, 2022 •

edited

Loading