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.ContainerInstance to add version stable/2021-03-01 #14059

Conversation

novinc
Copy link
Contributor

@novinc novinc commented Apr 21, 2021

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

Contribution checklist:

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

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
    • adding/removing APIs.
    • adding/removing properties.
    • adding/removing API-version.
    • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

@openapi-workflow-bot
Copy link

Hi, @novinc 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 Apr 21, 2021

    Swagger Validation Report

    ️❌BreakingChange: 7 Errors, 0 Warnings failed [Detail]
    Rule Message
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach' removed or restructured?
    Old: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L605:5
    1022 - RemovedAdditionalProperties The new version removes the 'additionalProperties' element.
    New: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1441:9
    Old: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1438:9
    1026 - TypeChanged The new version has a different type 'array' than the previous one 'object'.
    New: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1146:9
    Old: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1146:9
    1026 - TypeChanged The new version has a different type 'string' than the previous one 'object'.
    New: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1441:9
    Old: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1438:9
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'name' renamed or removed?
    Old: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1783:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'value' renamed or removed?
    Old: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1783:7
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L605:5
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1203
    R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1360
    R4009 - RequiredReadOnlySystemData The response of operation:'ContainerGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L114
    R4009 - RequiredReadOnlySystemData The response of operation:'ContainerGroups_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L155
    R4009 - RequiredReadOnlySystemData The response of operation:'ContainerGroups_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L209
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L520
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L791
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L853
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L876
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json#L1672
    ️️✔️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 BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"containerinstance/resource-manager/readme.md",
    "tag":"package-2021-03",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"containerinstance/resource-manager/readme.md",
    "tag":"package-2021-03",
    "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":"containerinstance/resource-manager/readme.md",
    "tag":"package-2021-03",
    "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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 21, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs] Generate from d07bf88f73f406ef1224a96b591bde868255f42c. 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-containerinstance [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model LogAnalytics has a new parameter workspace_resource_id
      info	[Changelog]   - Model ContainerHttpGet has a new parameter http_headers
      info	[Changelog]   - Added operation ContainersOperations.attach
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation ContainersOperations.list_logs has a new signature
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d07bf88f73f406ef1224a96b591bde868255f42c. 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/containerinstance/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.Management.ContainerInstance [View full logs]  [Preview SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d07bf88f73f406ef1224a96b591bde868255f42c. 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
    • ️✔️containerinstance/mgmt/2020-11-01/containerinstance [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️containerinstance/mgmt/2019-12-01/containerinstance [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️containerinstance/mgmt/2018-10-01/containerinstance [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️containerinstance/mgmt/2018-09-01/containerinstance [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️containerinstance/mgmt/2018-06-01/containerinstance [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️containerinstance/mgmt/2018-04-01/containerinstance [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/containerinstance/mgmt/2018-02-01-preview/containerinstance [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/containerinstance/mgmt/2017-12-01-preview/containerinstance [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/containerinstance/mgmt/2017-10-01-preview/containerinstance [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/containerinstance/mgmt/2017-08-01-preview/containerinstance [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from d07bf88f73f406ef1224a96b591bde868255f42c. 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-containerinstance [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model LogAnalytics has a new parameter workspace_resource_id
      info	[Changelog]   - Model ContainerHttpGet has a new parameter http_headers
      info	[Changelog]   - Added operation ContainersOperations.attach
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation ContainersOperations.list_logs has a new signature
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d07bf88f73f406ef1224a96b591bde868255f42c. 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
    • ️✔️containerinstance [View full logs]  [Preview Schema Changes]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from d07bf88f73f406ef1224a96b591bde868255f42c. 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-05-05 23:56:07 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-containerinstance-generated"
      cmderr	[generate.py] 2021-05-05 23:56:07 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-05-05 23:56:07 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.25 --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/containerinstance/azure-resourcemanager-containerinstance-generated --java.namespace=com.azure.resourcemanager.containerinstance.generated   --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/containerinstance/resource-manager/readme.md
      cmderr	[generate.py] 2021-05-05 23:56:42 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-05-05 23:56:42 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-05-05 23:56:42 INFO [POM][Skip] pom already has module azure-resourcemanager-containerinstance-generated
      cmderr	[generate.py] 2021-05-05 23:56:42 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-05-05 23:56:42 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-05-05 23:56:42 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-containerinstance-generated [View full logs]  [Preview SDK Changes]
      cmderr	[Inst] 2021-05-06 00:00:02 DEBUG Got artifact_id: azure-resourcemanager-containerinstance-generated
      cmderr	[Inst] 2021-05-06 00:00:02 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-05-06 00:00:02 DEBUG Got artifact: azure-resourcemanager-containerinstance-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-05-06 00:00:02 DEBUG Match jar package: azure-resourcemanager-containerinstance-generated-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-05-06 00:00:02 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14059/azure-sdk-for-java/azure-resourcemanager-containerinstance-generated/azure-resourcemanager-containerinstance-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-containerinstance-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-containerinstance-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-containerinstance-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d07bf88f73f406ef1224a96b591bde868255f42c. 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.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/containerinstance/resource-manager/readme.md
    • ️✔️@azure/arm-containerinstance [View full logs]  [Preview 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/containerInstanceManagementClient.js → ./dist/arm-containerinstance.js...
      cmderr	[npmPack] created ./dist/arm-containerinstance.js in 293ms
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    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.

    @novinc novinc added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 21, 2021
    @openapi-workflow-bot
    Copy link

    Hi, @novinc your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @PhoenixHe-msft

    @openapi-workflow-bot
    Copy link

    Hi @novinc, 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.

    @novinc
    Copy link
    Contributor Author

    novinc commented Apr 21, 2021

    Justification for breaking change:
    The property type was set incorrectly. Anyone attempting to use it would run into an error. This simply fixes it.

    @PhoenixHe-NV
    Copy link
    Contributor

    @novinc Please submit for breaking change review and bring your justification there, then I could merge this PR after you got approval.

    @novinc
    Copy link
    Contributor Author

    novinc commented Apr 26, 2021

    @novinc Please submit for breaking change review and bring your justification there, then I could merge this PR after you got approval.

    Thanks, I have sent the instructions to our PM. Although I understand the need for this review process it seems a bit excessive for this case as the current swagger is broken and anyone attempting to use the broken parts of the model would run into errors from our control plane. Given this fact, it's fair to say the customer impact of this breaking change is close to zero.

    @PhoenixHe-NV
    Copy link
    Contributor

    @novinc We need a formal process in swagger review to make sure the merged breaking change do really has near to zero impact to customer, or we need to kick off another process for breaking change update. We appreciate your understanding.

    @chiragg4u chiragg4u removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 28, 2021
    @chiragg4u
    Copy link
    Contributor

    ARM API review is not required for this PR, please follow the process given @ https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/212/Swagger-PR-Review

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

    @ghost
    Copy link

    ghost commented May 23, 2021

    Hi, @novinc. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @PhoenixHe-NV
    Copy link
    Contributor

    @novinc Please reopen and submit breaking change review if you want to merge this PR.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants