Skip to content

Conversation

joseph-porter
Copy link
Contributor

@joseph-porter joseph-porter commented Jun 17, 2022

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

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @joseph-porter 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]

    @joseph-porter joseph-porter marked this pull request as ready for review June 20, 2022 17:16
    @joseph-porter
    Copy link
    Contributor Author

    /azp run unifiedPipeline

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 20, 2022

    Swagger Validation Report

    ️❌BreakingChange: 5 Errors, 8 Warnings failed [Detail]
    Rule Message
    1011 - AddingResponseCode The new version adds a response code '204'.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L405:11
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'dnsNameLabelReusePolicy' renamed or removed?
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1614:7
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1554:7
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L772:5
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'id' in response that was not found in the old version.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1839:7
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1777:7
    1041 - AddedPropertyInResponse The new version has a new property 'autoGeneratedDomainNameLabelScope' in response that was not found in the old version.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1614:7
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1554:7
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1887:11
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1820:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L143:13
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L143:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L182:13
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L182:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L190:13
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L190:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L196:13
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L196:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L244:13
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L244:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L282:13
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L282:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1303:5
    Old: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1253:5
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ContainerInstance/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L418
    R4037 - MissingTypeObject The schema 'GitRepoVolume' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1140
    R4037 - MissingTypeObject The schema 'ContainerGroupIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1459
    R4037 - MissingTypeObject The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L2278
    R4037 - MissingTypeObject The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L2287
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: timestamps
    Location: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L531
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: readOnly
    Location: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1114
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: readOnly
    Location: Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json#L1205
    ⚠️ R4009 - RequiredReadOnlySystemData The response of operation:'ContainerGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ContainerInstance/stable/2021-10-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-10-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-10-01/containerInstance.json#L209
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️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.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 20, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-go - armcontainerinstance - Approved - 2.0.0
    +	Const `AutoGeneratedDomainNameLabelScopeNoreuse` has been removed
    +	Const `AutoGeneratedDomainNameLabelScopeResourceGroupReuse` has been removed
    +	Const `AutoGeneratedDomainNameLabelScopeSubscriptionReuse` has been removed
    +	Const `AutoGeneratedDomainNameLabelScopeTenantReuse` has been removed
    +	Const `AutoGeneratedDomainNameLabelScopeUnsecure` has been removed
    +	Function `PossibleAutoGeneratedDomainNameLabelScopeValues` has been removed
    +	Struct `Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties` has been removed
    azure-sdk-for-python-track2 - track2_azure-mgmt-containerinstance - Approved - 9.2.0
    +	Model IpAddress no longer has parameter dns_name_label_reuse_policy
    azure-sdk-for-js - @azure/arm-containerinstance - Approved - 9.0.0
    +	Interface IpAddress no longer has parameter dnsNameLabelReusePolicy
    +	Removed Enum KnownAutoGeneratedDomainNameLabelScope
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 61c0292. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_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
      cmderr	[Autorest] No usable version of the libssl was found
      cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
      cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 61c0292. 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
      cmderr	[automation_generate.sh]  global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-containerinstance [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group SubnetServiceAssociationLinkOperations
      info	[Changelog]   - Model IpAddress has a new parameter auto_generated_domain_name_label_scope
      info	[Changelog]   - Model Usage has a new parameter id
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model IpAddress no longer has parameter dns_name_label_reuse_policy
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 61c0292. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️armcontainerinstance [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `ContainerGroup.Properties` has been changed from `*ContainerGroupProperties` to `*ContainerGroupPropertiesProperties`
      info	[Changelog] - Type of `ContainerGroupIdentity.UserAssignedIdentities` has been changed from `map[string]*Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties` to `map[string]*UserAssignedIdentities`
      info	[Changelog] - Const `AutoGeneratedDomainNameLabelScopeSubscriptionReuse` has been removed
      info	[Changelog] - Const `AutoGeneratedDomainNameLabelScopeUnsecure` has been removed
      info	[Changelog] - Const `AutoGeneratedDomainNameLabelScopeTenantReuse` has been removed
      info	[Changelog] - Const `AutoGeneratedDomainNameLabelScopeResourceGroupReuse` has been removed
      info	[Changelog] - Const `AutoGeneratedDomainNameLabelScopeNoreuse` has been removed
      info	[Changelog] - Function `PossibleAutoGeneratedDomainNameLabelScopeValues` has been removed
      info	[Changelog] - Struct `Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties` has been removed
      info	[Changelog] - Field `DNSNameLabelReusePolicy` of struct `IPAddress` has been removed
      info	[Changelog] - Field `OSType` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `EncryptionProperties` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `SubnetIDs` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `Volumes` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `Diagnostics` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `ProvisioningState` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `IPAddress` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `InitContainers` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `RestartPolicy` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `SKU` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `DNSConfig` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `Containers` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `InstanceView` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `ImageRegistryCredentials` of struct `ContainerGroupProperties` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `DNSNameLabelReusePolicyResourceGroupReuse`
      info	[Changelog] - New const `DNSNameLabelReusePolicySubscriptionReuse`
      info	[Changelog] - New const `DNSNameLabelReusePolicyUnsecure`
      info	[Changelog] - New const `DNSNameLabelReusePolicyNoreuse`
      info	[Changelog] - New const `DNSNameLabelReusePolicyTenantReuse`
      info	[Changelog] - New function `*SubnetServiceAssociationLinkClient.BeginDelete(context.Context, string, string, string, *SubnetServiceAssociationLinkClientBeginDeleteOptions) (*runtime.Poller[SubnetServiceAssociationLinkClientDeleteResponse], error)`
      info	[Changelog] - New function `NewSubnetServiceAssociationLinkClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SubnetServiceAssociationLinkClient, error)`
      info	[Changelog] - New function `PossibleDNSNameLabelReusePolicyValues() []DNSNameLabelReusePolicy`
      info	[Changelog] - New struct `ContainerGroupPropertiesProperties`
      info	[Changelog] - New struct `SubnetServiceAssociationLinkClient`
      info	[Changelog] - New struct `SubnetServiceAssociationLinkClientBeginDeleteOptions`
      info	[Changelog] - New struct `SubnetServiceAssociationLinkClientDeleteResponse`
      info	[Changelog] - New struct `UserAssignedIdentities`
      info	[Changelog] - New field `ID` in struct `Usage`
      info	[Changelog] - New field `AutoGeneratedDomainNameLabelScope` in struct `IPAddress`
      info	[Changelog] - New field `Properties` in struct `ContainerGroupProperties`
      info	[Changelog] - New field `Identity` in struct `ContainerGroupProperties`
      info	[Changelog]
      info	[Changelog] Total 12 breaking change(s), 21 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 61c0292. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      cmderr	[automation_init.sh] deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] WARN deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh]  @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-containerinstance [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group SubnetServiceAssociationLink
      info	[Changelog]   - Added Interface ContainerGroupProperties
      info	[Changelog]   - Added Interface SubnetServiceAssociationLinkDeleteOptionalParams
      info	[Changelog]   - Added Interface UserAssignedIdentities
      info	[Changelog]   - Added Type Alias ContainerGroup
      info	[Changelog]   - Added Type Alias DnsNameLabelReusePolicy
      info	[Changelog]   - Interface IpAddress has a new optional parameter autoGeneratedDomainNameLabelScope
      info	[Changelog]   - Interface Usage has a new optional parameter id
      info	[Changelog]   - Class ContainerInstanceManagementClient has a new parameter subnetServiceAssociationLink
      info	[Changelog]   - Added Enum KnownDnsNameLabelReusePolicy
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Interface IpAddress no longer has parameter dnsNameLabelReusePolicy
      info	[Changelog]   - Removed Enum KnownAutoGeneratedDomainNameLabelScope
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 61c0292. 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
    • ️✔️containerinstance [View full logs]  [Release Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 61c0292. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.ContainerInstance [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @azure-pipelines
    Copy link

    No pipelines are associated with this pull request.

    @openapi-workflow-bot
    Copy link

    Hi @joseph-porter, 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.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

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

    @joseph-porter
    Copy link
    Contributor Author

    joseph-porter commented Jun 30, 2022

    @honghr Could we get an approval here? These are fixes for correctness/completeness S360 items and are not API changes.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 7, 2022
    @joseph-porter
    Copy link
    Contributor Author

    @honghr Now that this have Breaking Change approval. Can we proceed with review and approval?

    @joseph-porter
    Copy link
    Contributor Author

    @honghr Any update here? We really want to push these changes through to address the S360 items.

    @honghr
    Copy link
    Contributor

    honghr commented Jul 11, 2022

    You also have sdk breaking change. I will contact with SDK owner to review it asap.

    @honghr honghr merged commit 61c0292 into Azure:main Jul 13, 2022
    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Jul 13, 2022
    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-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript Approved-SdkBreakingChange-Python CI-BreakingChange-Go CI-BreakingChange-JavaScript FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants