Skip to content

Conversation

@tokaplan
Copy link
Contributor

@tokaplan tokaplan commented Oct 14, 2021

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

Changelog

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

  1. 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
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific langauge 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:

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 apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
  • 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
Copy link

Hi, @tokaplan 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. [email protected]

    @openapi-workflow-bot
    Copy link

    [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.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 14, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 2 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R4006 - DeprecatedXmsCodeGenerationSetting The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation.
    Location: Microsoft.Insights/stable/2021-10-14/livetoken_API.json#L5
    ⚠️ R4021 - DescriptionAndTitleMissing 'ErrorResponseLinkedStorage' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json#L219
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️❌Cross-Version Breaking Changes: 2 Errors, 0 Warnings failed [Detail]
    The following breaking changes are detected by comparison with latest preview version:
    Rule Message
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/microsoft.insights/operations' removed or restructured?
    Old: Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json#L39:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/{resourceUri}/providers/microsoft.insights/generatelivetoken' removed or restructured?
    Old: Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json#L77:5
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️[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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 14, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - appinsights/mgmt/2020-02-02/insights - Approved - v58.2.0
    ️✔️azure-sdk-for-go - appinsights/mgmt/2015-05-01/insights - Approved - v58.2.0
    azure-sdk-for-go - preview/appinsights/mgmt/2020-02-02-preview/insights - Approved - v58.2.0
    +	Package was removed
    azure-sdk-for-python-track2 - track2_azure-mgmt-applicationinsights - 1.0.0
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8179a9e. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/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
    • ️✔️Microsoft.Azure.ApplicationInsights [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8179a9e. 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.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-applicationinsights [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model ErrorResponse has a new parameter error
      info	[Changelog]   - Model Operation has a new parameter origin
      info	[Changelog]   - Model Operation has a new parameter properties
      info	[Changelog]   - Model WebTest has a new parameter validation_rules
      info	[Changelog]   - Model WebTest has a new parameter request
      info	[Changelog]   - Model ApplicationInsightsComponent has a new parameter force_customer_storage_for_profiler
      info	[Changelog]   - Model ApplicationInsightsComponent has a new parameter disable_local_auth
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model ErrorResponse no longer has parameter message
      info	[Changelog]   - Model ErrorResponse no longer has parameter code
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8179a9e. 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
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-10-22 07:08:34 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-applicationinsights;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2021-10-22 07:08:34 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-10-22 07:08:34 INFO autorest --version=3.6.0 --use=@autorest/[email protected] --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/applicationinsights/azure-resourcemanager-applicationinsights --java.namespace=com.azure.resourcemanager.applicationinsights   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --generate-samples --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/applicationinsights/resource-manager/readme.md
      cmderr	[generate.py] 2021-10-22 07:09:03 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-applicationinsights
      cmderr	[generate.py] 2021-10-22 07:09:03 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-10-22 07:09:03 INFO [POM][Skip] pom already has module azure-resourcemanager-applicationinsights
      cmderr	[generate.py] 2021-10-22 07:09:03 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-10-22 07:09:03 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-10-22 07:09:03 INFO [POM][Skip] pom already has module sdk/applicationinsights
      cmderr	[generate.py] 2021-10-22 07:09:03 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-applicationinsights [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-10-22 07:10:57 DEBUG Got artifact_id: azure-resourcemanager-applicationinsights
      cmderr	[Inst] 2021-10-22 07:10:57 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-10-22 07:10:57 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-10-22 07:10:57 DEBUG Match jar package: azure-resourcemanager-applicationinsights-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-10-22 07:10:57 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/16417/azure-sdk-for-java/azure-resourcemanager-applicationinsights/azure-resourcemanager-applicationinsights-1.0.0-beta.2.jar\" -o azure-resourcemanager-applicationinsights-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-applicationinsights -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-applicationinsights-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8179a9e. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️appinsights/mgmt/2020-02-02/insights [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️appinsights/mgmt/2015-05-01/insights [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/appinsights/mgmt/2020-02-02-preview/insights [View full logsBreaking Change Detected
      info	[Changelog] This package was removed
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8179a9e. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/applicationinsights/resource-manager/readme.md
    • ️✔️@azure/arm-appinsights [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/applicationInsightsManagementClient.js → ./dist/arm-appinsights.js...
      cmderr	[npmPack] created ./dist/arm-appinsights.js in 153ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8179a9e. 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
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️applicationinsights [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @tokaplan, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @openapi-workflow-bot
    Copy link

    Hi, @tokaplan your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @tokaplan
    Copy link
    Contributor Author

    /azp run unifiedPipeline

    @azure-pipelines
    Copy link

    No pipelines are associated with this pull request.

    @tokaplan tokaplan marked this pull request as ready for review October 14, 2021 22:46
    @akning-ms
    Copy link
    Contributor

    Hi @tokaplan, before I can merge:

    1. you need to fix 5 Linter issues first
    2. +@ArcturusZhang to review the Breaking change for GO SDK

    @tokaplan
    Copy link
    Contributor Author

    @akning-ms I've fixed the Linter issues, other issues don't seem relevant to my change, I'm going to need some help with those. All I'm doing is copying over an older -preview api version and making it stable.

    @ArcturusZhang ArcturusZhang added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Oct 22, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants