Skip to content

Conversation

tomvcassidy
Copy link
Contributor

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

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 --> Updating existing version for existing feature.
  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. Already live.
  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 language 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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 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, @tomvcassidy 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 Jul 25, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.9.6)] new version base version
    containerInstance.json 2021-10-01(521c1f6) 2021-10-01(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2021-10 package-2021-10(521c1f6) package-2021-10(main)

    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#L2281
    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#L2290
    ⚠️ 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.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/521c1f671149599c769a79e04bcbfcc687457b07/specification/containerinstance/resource-manager/readme.md#tag-package-2021-10">containerinstance/resource-manager/readme.md#package-2021-10
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"containerinstance/resource-manager/readme.md",
    "tag":"package-2021-10",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 25, 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 - 2.0.0
    +	Field `Containers` of struct `ContainerGroupProperties` has been removed
    +	Field `DNSConfig` of struct `ContainerGroupProperties` has been removed
    +	Field `DNSNameLabelReusePolicy` of struct `IPAddress` has been removed
    +	Field `Diagnostics` of struct `ContainerGroupProperties` has been removed
    +	Field `EncryptionProperties` of struct `ContainerGroupProperties` has been removed
    +	Field `IPAddress` of struct `ContainerGroupProperties` has been removed
    +	Field `ImageRegistryCredentials` of struct `ContainerGroupProperties` has been removed
    +	Field `InitContainers` of struct `ContainerGroupProperties` has been removed
    +	Field `InstanceView` of struct `ContainerGroupProperties` has been removed
    +	Field `OSType` of struct `ContainerGroupProperties` has been removed
    +	Field `ProvisioningState` of struct `ContainerGroupProperties` has been removed
    +	Field `RestartPolicy` of struct `ContainerGroupProperties` has been removed
    +	Field `SKU` of struct `ContainerGroupProperties` has been removed
    +	Field `SubnetIDs` of struct `ContainerGroupProperties` has been removed
    +	Field `Volumes` of struct `ContainerGroupProperties` has been removed
    +	Type of `ContainerGroup.Properties` has been changed from `*ContainerGroupProperties` to `*ContainerGroupPropertiesProperties`
    +	Type of `ContainerGroupIdentity.UserAssignedIdentities` has been changed from `map[string]*Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties` to `map[string]*UserAssignedIdentities`
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-containerinstance - 9.2.0
    ️✔️azure-sdk-for-js - @azure/arm-containerinstance - 9.0.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 1885c47. 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 1885c47. 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]  config 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 1885c47. 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 `AutoGeneratedDomainNameLabelScopeTenantReuse` has been removed
      info	[Changelog] - Const `AutoGeneratedDomainNameLabelScopeResourceGroupReuse` has been removed
      info	[Changelog] - Const `AutoGeneratedDomainNameLabelScopeNoreuse` has been removed
      info	[Changelog] - Const `AutoGeneratedDomainNameLabelScopeSubscriptionReuse` has been removed
      info	[Changelog] - Const `AutoGeneratedDomainNameLabelScopeUnsecure` 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 `EncryptionProperties` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `RestartPolicy` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `OSType` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `IPAddress` 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 `ProvisioningState` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `SubnetIDs` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `InstanceView` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `InitContainers` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `Diagnostics` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `Containers` of struct `ContainerGroupProperties` has been removed
      info	[Changelog] - Field `Volumes` 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 `DNSNameLabelReusePolicyTenantReuse`
      info	[Changelog] - New const `DNSNameLabelReusePolicySubscriptionReuse`
      info	[Changelog] - New const `DNSNameLabelReusePolicyNoreuse`
      info	[Changelog] - New const `DNSNameLabelReusePolicyUnsecure`
      info	[Changelog] - New const `DNSNameLabelReusePolicyResourceGroupReuse`
      info	[Changelog] - New function `NewSubnetServiceAssociationLinkClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SubnetServiceAssociationLinkClient, error)`
      info	[Changelog] - New function `PossibleDNSNameLabelReusePolicyValues() []DNSNameLabelReusePolicy`
      info	[Changelog] - New function `*SubnetServiceAssociationLinkClient.BeginDelete(context.Context, string, string, string, *SubnetServiceAssociationLinkClientBeginDeleteOptions) (*runtime.Poller[SubnetServiceAssociationLinkClientDeleteResponse], error)`
      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 `Properties` in struct `ContainerGroupProperties`
      info	[Changelog] - New field `Identity` in struct `ContainerGroupProperties`
      info	[Changelog] - New field `ID` in struct `Usage`
      info	[Changelog] - New field `AutoGeneratedDomainNameLabelScope` in struct `IPAddress`
      info	[Changelog]
      info	[Changelog] Total 12 breaking change(s), 21 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1885c47. 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
      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 1885c47. 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]  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 1885c47. 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?

    @tomvcassidy
    Copy link
    Contributor Author

    @jianyexi Is this breaking change the result of something I did? I was just trying to expand the description of an existing entry.

    @jianyexi jianyexi merged commit 1885c47 into Azure:main Jul 28, 2022
    @tomvcassidy tomvcassidy deleted the descriptionDnsPolicyAci branch July 31, 2024 15:30
    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.

    2 participants