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

[Hub Generated] Review request for Microsoft.Insights to add version preview/2018-05-01-preview #15636

Conversation

grlima
Copy link
Contributor

@grlima grlima commented Aug 12, 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, @grlima 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 12, 2021

    Swagger Validation Report

    ️❌BreakingChange: 5 Errors, 0 Warnings failed [Detail]
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L37:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L75:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L108:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L261:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L291:5
    ️❌LintDiff: 6 Errors, 0 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Insights/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L37
    R4037 - MissingTypeObject The schema 'WebtestsResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L329
    R4037 - MissingTypeObject The schema 'tags' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L354
    R4037 - MissingTypeObject The schema 'webTestListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L378
    R4037 - MissingTypeObject The schema 'WebTest' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L397
    R4037 - MissingTypeObject The schema 'WebTestProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L425


    The following errors/warnings exist before current PR submission:

    Rule Message
    R4037 - MissingTypeObject The schema 'ComponentsResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L333
    R4037 - MissingTypeObject The schema 'tags' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L358
    R4037 - MissingTypeObject The schema 'TagsResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L371
    R4037 - MissingTypeObject The schema 'tags' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L373
    R4037 - MissingTypeObject The schema 'ApplicationInsightsComponent' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L382
    R4037 - MissingTypeObject The schema 'ApplicationInsightsComponentProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L404
    R4037 - MissingTypeObject The schema 'PrivateLinkScopedResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L555
    R4037 - MissingTypeObject The schema 'ApplicationInsightsComponentListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L568
    R4037 - MissingTypeObject The schema 'ComponentPurgeBody' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L587
    R4037 - MissingTypeObject The schema 'ComponentPurgeBodyFilters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L607
    R4037 - MissingTypeObject The schema 'ComponentPurgeResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L627
    R4037 - MissingTypeObject The schema 'ComponentPurgeStatusResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L639
    R4037 - MissingTypeObject The schema 'TagsResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L367
    R4037 - MissingTypeObject The schema 'tags' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L369
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'ProactiveDetectionConfigs' with immediate parent 'ApplicationInsightsComponent', must have a list by immediate parent operation.
    Location: Microsoft.Insights/preview/2018-05-01-preview/componentProactiveDetection_API.json#L158
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'operations' with immediate parent 'ApplicationInsightsComponent', must have a list by immediate parent operation.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L639
    ⚠️ R4024 - PreviewVersionOverOneYear The API version:2018-05-01-preview having been in a preview state over one year , please move it to GA or retire.
    Location: Microsoft.Insights/preview/2018-05-01-preview/componentProactiveDetection_API.json#L6
    ⚠️ R4024 - PreviewVersionOverOneYear The API version:2018-05-01-preview having been in a preview state over one year , please move it to GA or retire.
    Location: Microsoft.Insights/preview/2018-05-01-preview/components_API.json#L6
    ⚠️ R4024 - PreviewVersionOverOneYear The API version:2018-05-01-preview having been in a preview state over one year , please move it to GA or retire.
    Location: Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json#L6
    ⚠️ 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/preview/2018-05-01-preview/components_API.json#L324
    ️️✔️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 succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️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-2018-05-01-preview",
    "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/preview/2018-05-01-preview/components_API.json#/components/schemas/ComponentPurgeBodyFilters-value"
    💬 AutorestCore/Exception "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2018-05-01-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"
    💬 AutorestCore/Exception "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2018-05-01-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2018-05-01-preview",
    "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 Aug 12, 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-python-track2 - track2_azure-mgmt-applicationinsights - 1.0.0
    ️✔️azure-sdk-for-go - appinsights/mgmt/2020-02-02/insights - v56.3.0
    ️✔️azure-sdk-for-go - appinsights/mgmt/2015-05-01/insights - v56.3.0
    azure-sdk-for-go - preview/appinsights/mgmt/2020-02-02-preview/insights - v56.2.0
    +	Package was removed
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from e1eca38. 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 --use=@microsoft.azure/autorest.csharp@2.3.82 --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 e1eca38. 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 Operation has a new parameter origin
      info	[Changelog]   - Model Operation has a new parameter properties
      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]   - Model WebTest has a new parameter request
      info	[Changelog]   - Model WebTest has a new parameter validation_rules
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model ErrorResponse has a new signature
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from e1eca38. 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-08-25 05:53:37 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-08-25 05:53:37 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-08-25 05:53:37 INFO autorest --version=3.4.5 --use=@autorest/java@4.0.36 --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-08-25 05:54:06 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-applicationinsights
      cmderr	[generate.py] 2021-08-25 05:54:06 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-08-25 05:54:06 INFO [POM][Skip] pom already has module azure-resourcemanager-applicationinsights
      cmderr	[generate.py] 2021-08-25 05:54:06 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-08-25 05:54:06 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-08-25 05:54:06 INFO [POM][Skip] pom already has module sdk/applicationinsights
      cmderr	[generate.py] 2021-08-25 05:54:06 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-applicationinsights [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-08-25 05:55:44 DEBUG Got artifact_id: azure-resourcemanager-applicationinsights
      cmderr	[Inst] 2021-08-25 05:55:44 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-08-25 05:55:44 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.2-sources.jar
      cmderr	[Inst] 2021-08-25 05:55:44 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-08-25 05:55:44 DEBUG Match jar package: azure-resourcemanager-applicationinsights-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-08-25 05:55:44 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/15636/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 e1eca38. 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
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from e1eca38. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.7.0 --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 149ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from e1eca38. 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 @grlima, 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

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    }
    },
    "paths": {
    "/providers/Microsoft.Insights/operations": {
    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    This doesn't belong to web test, I think. Should we remove it?

    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    it is not need if other files in the tag in readme include operations
    BTW, you should add webTests_API.json in one of tag of readme. otherwise it causes lots of Avocado validation failure

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    Thank you! I was going nuts trying to figure out what this Avocado was complaining about. Added webTests_API.json to the tag in readme

    @akning-ms
    Copy link
    Contributor

    Hi @grlima, guess you are adding missing webTests_API in 2018-05-01-preview to fix S360 issue.
    If you are also planning a new API version soon. it also can be fixed as we just track latest 2 API.
    Can you help confirm?

    @grlima
    Copy link
    Contributor Author

    grlima commented Aug 19, 2021

    Hi @grlima, guess you are adding missing webTests_API in 2018-05-01-preview to fix S360 issue.
    If you are also planning a new API version soon. it also can be fixed as we just track latest 2 API.
    Can you help confirm?

    Yes, we're trying to fix S360. I'm confirming with the team. I think we're planning a new version, but it might be a while until it's out. What would be the correct approach? Is there some exception we can apply for until this new version is out? Thank you for your help!

    @akning-ms
    Copy link
    Contributor

    Hi @grlima

            Gustavo Lima
            FTE, guess you are adding missing webTests_API in 2018-05-01-preview to fix S360 issue.
    

    If you are also planning a new API version soon. it also can be fixed as we just track latest 2 API.
    Can you help confirm?

    Yes, we're trying to fix S360. I'm confirming with the team. I think we're planning a new version, but it might be a while until it's out. What would be the correct approach? Is there some exception we can apply for until this new version is out? Thank you for your help!

    If you are going to release a new version in one month. then you don't have to have this PR to fix. :)

    @akning-ms
    Copy link
    Contributor

    Looks you still have some linter issue to be fixed before I can help you merge

    @grlima
    Copy link
    Contributor Author

    grlima commented Aug 21, 2021

    /azp run unifiedPipeline

    @azure-pipelines
    Copy link

    No pipelines are associated with this pull request.

    @grlima
    Copy link
    Contributor Author

    grlima commented Aug 23, 2021

    Looks you still have some linter issue to be fixed before I can help you merge

    The linter issues being flagged are nothing new to this PR. I simply copied the same webTests_API.json from version "2020-10-05-preview" and changed the version to "2018-05-01-preview" (https://github.com/Azure/azure-rest-api-specs/blob/main/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-10-05-preview/webTests_API.json). I can also see similar type issues in the existing swagger (before my PR) => https://github.com/Azure/azure-rest-api-specs/pull/15636/checks?check_run_id=3387880003

    @akning-ms akning-ms added Approved-LintDiff Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 labels Aug 25, 2021
    @akning-ms akning-ms merged commit e1eca38 into Azure:main Aug 25, 2021
    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Aug 25, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-LintDiff CI-FixRequiredOnFailure FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants