Skip to content
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

Add 2020Public version #14337

Merged
merged 7 commits into from
Jun 1, 2021
Merged

Conversation

tofriedl
Copy link
Contributor

@tofriedl tofriedl commented May 10, 2021

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

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

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

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • 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.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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, @tofriedl 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 10, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ComponentPurge
    Location: Microsoft.Insights/stable/2020-02-02/components_API.json#L360
    ️️✔️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: 11 Errors, 0 Warnings failed [Detail]
    The following breaking changes are detected by comparison with the latest stable version:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Insights/stable/2020-02-02/components_API.json#L56:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Insights/stable/2020-02-02/components_API.json#L95:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Insights/stable/2020-02-02/components_API.json#L137:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Insights/stable/2020-02-02/components_API.json#L174:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Insights/stable/2020-02-02/components_API.json#L220:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Insights/stable/2020-02-02/components_API.json#L269:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Insights/stable/2020-02-02/components_API.json#L311:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Insights/stable/2020-02-02/components_API.json#L353:11
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Insights/stable/2020-02-02/components_API.json#L552:9
    Old: Microsoft.Insights/stable/2015-05-01/components_API.json#L495:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Insights/stable/2020-02-02/components_API.json#L591:9
    Old: Microsoft.Insights/stable/2015-05-01/components_API.json#L516:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ Modeler/MissingType "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-02",
    "details":"The schema 'ComponentPurgeBodyFilters-value' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/components_API.json#/components/schemas/ComponentPurgeBodyFilters-value"
    💬 AutorestCore/Exception "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-02",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"
    💬 AutorestCore/Exception "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-02",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"
    💬 AutorestCore/Exception "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-02",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
    ️️✔️[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-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 May 10, 2021

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - appinsights/mgmt/2015-05-01/insights - v55.0.0
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-applicationinsights - 1.0.0
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from bf2b044. 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 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bf2b044. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      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
    • ️✔️azure-mgmt-applicationinsights [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model Workbook has a new parameter source_id
      info	[Changelog]   - Model ApplicationInsightsComponent has a new parameter application_insights_component_name
      info	[Changelog]   - Model ApplicationInsightsComponent has a new parameter ingestion_mode
      info	[Changelog]   - Model ApplicationInsightsComponent has a new parameter force_customer_storage_for_profiler
      info	[Changelog]   - Model ApplicationInsightsComponent has a new parameter etag
      info	[Changelog]   - Model ApplicationInsightsComponent has a new parameter la_migration_date
      info	[Changelog]   - Model ApplicationInsightsComponent has a new parameter disable_local_auth
      info	[Changelog]   - Added operation group LiveTokenOperations
      info	[Changelog]   - Added operation group MyWorkbooksOperations
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bf2b044. 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]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model ApplicationInsightsComponent has a new parameter disable_local_auth
      info	[Changelog]   - Model ApplicationInsightsComponent has a new parameter force_customer_storage_for_profiler
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bf2b044. 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-06-01 09:47:48 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-06-01 09:47:48 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-06-01 09:47:48 INFO autorest --version=3.1.3 --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 --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-06-01 09:48:17 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-applicationinsights
      cmderr	[generate.py] 2021-06-01 09:48:17 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-06-01 09:48:17 INFO [POM][Skip] pom already has module azure-resourcemanager-applicationinsights
      cmderr	[generate.py] 2021-06-01 09:48:17 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-06-01 09:48:17 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-06-01 09:48:17 INFO [POM][Skip] pom already has module sdk/applicationinsights
      cmderr	[generate.py] 2021-06-01 09:48:17 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-applicationinsights [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-06-01 09:50:38 DEBUG Got artifact_id: azure-resourcemanager-applicationinsights
      cmderr	[Inst] 2021-06-01 09:50:38 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-06-01 09:50:38 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.2-sources.jar
      cmderr	[Inst] 2021-06-01 09:50:38 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.2-javadoc.jar
      cmderr	[Inst] 2021-06-01 09:50:38 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-06-01 09:50:38 DEBUG Match jar package: azure-resourcemanager-applicationinsights-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-06-01 09:50:38 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14337/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 bf2b044. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️appinsights/mgmt/2015-05-01/insights [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from bf2b044. 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 148ms
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from bf2b044. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      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 @tofriedl, 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, @tofriedl your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @kairu-ms

    @pilor
    Copy link
    Contributor

    pilor commented May 14, 2021

    Approving but please do not skip the "Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently." step in the PR description checklist next time

    @pilor pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 14, 2021
    @tofriedl
    Copy link
    Contributor Author

    tofriedl commented May 16, 2021 via email

    "IngestionMode": {
    "type": "string",
    "description": "Indicates the flow of the ingestion.",
    "default": "LogAnalytics",
    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    The default value changed from "ApplicationInsights" to "LogAnalytics" is it by design?

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @akning-ms Do we need breaking change review for Cross Version Breaking Change?

    @tofriedl
    Copy link
    Contributor Author

    tofriedl commented May 23, 2021 via email

    @openapi-workflow-bot
    Copy link

    Hi @tofriedl, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @kairu-ms
    Copy link
    Contributor

    kairu-ms commented May 24, 2021

    @tofriedl Your PR needs breaking change review, because there are some cross version breaking changes.

    @kairu-ms kairu-ms requested a review from JeffreyRichter May 24, 2021 02:10
    @kairu-ms kairu-ms assigned akning-ms and unassigned kairu-ms May 26, 2021
    @akning-ms
    Copy link
    Contributor

    One more question is: I saw your latest stable version is 2021-03-08, why you added a new API 2020-02-02, Not sure whether you have someone in your team to coordinate in different feature team for your RP. we recommend you have all your feature APIs available in one API version. ping me in team if need if need more clarify @tofriedl

    @akning-ms
    Copy link
    Contributor

    it is convert to stable version from 2020-02-02-preview. no any change actually, so merge it.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants