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

[CDN] Fix customDomains property type in Endpoint #19788

Merged
merged 2 commits into from
Jul 21, 2022

Conversation

t-bzhan
Copy link
Contributor

@t-bzhan t-bzhan commented Jul 15, 2022

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
  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 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, @t-bzhan 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 15, 2022

    Swagger Validation Report

    ️❌BreakingChange: 10 Errors, 2 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.6)] new version base version
    cdn.json 2021-06-01(00379c1) 2021-06-01(main)
    Rule Message
    1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5497:9
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L6298:9
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'resourceState' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5513:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5507:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'customHttpsProvisioningState' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5513:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5507:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'customHttpsProvisioningSubstate' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5513:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5507:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'customHttpsParameters' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5513:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5507:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'provisioningState' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5513:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5507:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'id' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5496:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5495:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'type' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5496:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5495:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'systemData' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5496:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5495:7
    1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2659:11
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2659:11
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5501:9
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L5496:9
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2659:11
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2659:11
    ️️✔️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-06 package-2021-06(00379c1) package-2021-06(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3267
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3267
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3267
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3313
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3313
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3313
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3344
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3344
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3344
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3366
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3366
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3366
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3419
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3419
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3419
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3476
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3476
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3476
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3529
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3529
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3529
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3586
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3586
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3586
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3639
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3639
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3639
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3645
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3645
    R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3645
    ️️✔️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 succeeded [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/00379c14246ca0d7d4a0857f1341312d6e489db9/specification/cdn/resource-manager/readme.md#tag-package-2021-06">cdn/resource-manager/readme.md#package-2021-06
    The following errors/warnings exist before current PR submission:
    Rule Message
    PreCheck/DuplicateSchema "readme":"cdn/resource-manager/readme.md",
    "tag":"package-2021-06",
    "details":"Duplicate Schema named 'DeliveryRuleAction' (6 differences):\n - discriminator: "propertyName":"name" =>\n - properties: "name":"x-ms-enum":"name":"DeliveryRuleAction",
    "modelAsString":true,
    "$ref":"#/components/schemas/DeliveryRuleAction",
    "description":"The name of the action for the delivery rule." =>\n - required: ["name"] =>\n - type: "object" => "string"\n - enum: => ["CacheExpiration",
    "CacheKeyQueryString",
    "ModifyRequestHeader",
    "ModifyResponseHeader",
    "UrlRedirect",
    "UrlRewrite",
    "UrlSigning",
    "OriginGroupOverride",
    "RouteConfigurationOverride"]\n - x-ms-enum: => "name":"DeliveryRuleAction",
    "modelAsString":true; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    "readme":"cdn/resource-manager/readme.md",
    "tag":"package-2021-06",
    "details":"Error: 1 errors occured -- cannot continue."
    ️️✔️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 15, 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 - armcdn - 2.0.0
    +	Function `*CustomDomainsClient.DisableCustomHTTPS` has been removed
    +	Function `*CustomDomainsClient.EnableCustomHTTPS` has been removed
    +	Struct `CustomDomainsClientDisableCustomHTTPSOptions` has been removed
    +	Struct `CustomDomainsClientEnableCustomHTTPSOptions` has been removed
    +	Type of `EndpointProperties.CustomDomains` has been changed from `[]*CustomDomain` to `[]*DeepCreatedCustomDomain`
    azure-sdk-for-python-track2 - track2_azure-mgmt-cdn - 12.0.0
    azure-sdk-for-js - @azure/arm-cdn - 8.0.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1147587. 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] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-cdn [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation CustomDomainsOperations.begin_disable_custom_https
      info	[Changelog]   - Added operation CustomDomainsOperations.begin_enable_custom_https
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Removed operation CustomDomainsOperations.disable_custom_https
      info	[Changelog]   - Removed operation CustomDomainsOperations.enable_custom_https
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1147587. 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
    • ️✔️armcdn [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `EndpointProperties.CustomDomains` has been changed from `[]*CustomDomain` to `[]*DeepCreatedCustomDomain`
      info	[Changelog] - Function `*CustomDomainsClient.DisableCustomHTTPS` has been removed
      info	[Changelog] - Function `*CustomDomainsClient.EnableCustomHTTPS` has been removed
      info	[Changelog] - Struct `CustomDomainsClientDisableCustomHTTPSOptions` has been removed
      info	[Changelog] - Struct `CustomDomainsClientEnableCustomHTTPSOptions` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `*CustomDomainsClient.BeginEnableCustomHTTPS(context.Context, string, string, string, string, *CustomDomainsClientBeginEnableCustomHTTPSOptions) (*runtime.Poller[CustomDomainsClientEnableCustomHTTPSResponse], error)`
      info	[Changelog] - New function `*CustomDomainsClient.BeginDisableCustomHTTPS(context.Context, string, string, string, string, *CustomDomainsClientBeginDisableCustomHTTPSOptions) (*runtime.Poller[CustomDomainsClientDisableCustomHTTPSResponse], error)`
      info	[Changelog] - New struct `CustomDomainsClientBeginDisableCustomHTTPSOptions`
      info	[Changelog] - New struct `CustomDomainsClientBeginEnableCustomHTTPSOptions`
      info	[Changelog] - New struct `DeepCreatedCustomDomain`
      info	[Changelog] - New struct `DeepCreatedCustomDomainProperties`
      info	[Changelog]
      info	[Changelog] Total 7 breaking change(s), 10 additive change(s).
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 1147587. 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 --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/cdn/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-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1147587. 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 read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] deprecated uuid@3.4.0: 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] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh]  deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 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-cdn [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation CustomDomains.beginDisableCustomHttps
      info	[Changelog]   - Added operation CustomDomains.beginDisableCustomHttpsAndWait
      info	[Changelog]   - Added operation CustomDomains.beginEnableCustomHttps
      info	[Changelog]   - Added operation CustomDomains.beginEnableCustomHttpsAndWait
      info	[Changelog]   - Added Interface DeepCreatedCustomDomain
      info	[Changelog]   - Added Type Alias EndpointProvisioningState
      info	[Changelog]   - Added Type Alias OriginGroupProvisioningState
      info	[Changelog]   - Added Type Alias OriginProvisioningState
      info	[Changelog]   - Added Type Alias ProfileProvisioningState
      info	[Changelog]   - Added Type Alias ResourceUsageUnit
      info	[Changelog]   - Interface CustomDomainsDisableCustomHttpsOptionalParams has a new optional parameter resumeFrom
      info	[Changelog]   - Interface CustomDomainsDisableCustomHttpsOptionalParams has a new optional parameter updateIntervalInMs
      info	[Changelog]   - Interface CustomDomainsEnableCustomHttpsOptionalParams has a new optional parameter resumeFrom
      info	[Changelog]   - Interface CustomDomainsEnableCustomHttpsOptionalParams has a new optional parameter updateIntervalInMs
      info	[Changelog]   - Added Enum KnownEndpointProvisioningState
      info	[Changelog]   - Added Enum KnownOriginGroupProvisioningState
      info	[Changelog]   - Added Enum KnownOriginProvisioningState
      info	[Changelog]   - Added Enum KnownProfileProvisioningState
      info	[Changelog]   - Added Enum KnownResourceUsageUnit
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Removed operation CustomDomains.disableCustomHttps
      info	[Changelog]   - Removed operation CustomDomains.enableCustomHttps
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1147587. 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
      warn	No file changes detected after generation
    • ️✔️cdn [View full logs
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 1147587. 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
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @t-bzhan, 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

    Hi @t-bzhan, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @akning-ms
    Copy link
    Contributor

    @qiaozha @msyyc to review js, python sdk breaking change

    @t-bzhan
    Copy link
    Contributor Author

    t-bzhan commented Jul 19, 2022

    The breaking change is introduced to align swagger with service's behavior, I will try to ask the swagger breaking change review board for an approval.

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

    t-bzhan commented Jul 21, 2022

    @akning-ms , the breaking change get approved, is there anything needed from my side to get the PR merged?

    @akning-ms
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @akning-ms akning-ms merged commit 1147587 into Azure:main Jul 21, 2022
    akning-ms pushed a commit that referenced this pull request Aug 1, 2022
    * update folder structure
    
    * small errors and CI check
    
    * [Language Text] Update swagger titles (#19835)
    
    * [Language Text] Update swagger titles
    
    * edits
    
    * address feedback
    
    * Review request for Microsoft.ContainerService to add version 2022-06-01 (#19848)
    
    * Adds base for updating Microsoft.ContainerService from version stable/2022-04-01 to version 2022-06-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * update readmes (#19421)
    
    * Add key management service profile of a managed cluster for version 2022-06-01 (#19529)
    
    * Add NetworkPlugin none option to 2022-06-01 (#19510)
    
    * Add NetworkPlugin none option to 2022-06-01
    
    * improve description for none value
    
    * Fix violated rule R4041 for 2022-06-01 managedCluster swagger (#19581)
    
    * remove useless directive
    
    * fix R4041
    
    * GA AKS support for Dedicated Host Group (#19547)
    
    * GA AKS support for Dedicated Host Group
    
    * fit some format minor issue
    
    * add newline in end of files
    
    * Defender updates (#19665)
    
    * Defender updates
    
    * sample
    
    * remove old description
    
    Co-authored-by: Bin Xia <binxi@microsoft.com>
    Co-authored-by: Matt Stam <mattstam@live.com>
    Co-authored-by: Jianping Zeng <zjpjack@users.noreply.github.com>
    Co-authored-by: Or Parnes <orparnes@microsoft.com>
    
    * Update resources.json (#19861)
    
    * Pattts/predictive autoscale 20221001 (#19765)
    
    * Rev Autoscale API from 2021-05-01-preview to 2022-10-01.
    
    * Fix minor swagger issue. Default should be 'false'
    
    * Fix swagger validation error
    
    * Defining a new package 2022-10
    
    * AutoscaleSettingResource now reference allOf 'resource' which is the actual autoscaleSetting resource definition
    
    * Fix require property issue
    
    * Run prettier against autoscale_API.json
    
    * [Maps - Render & Spatial Services] add v2022-08-01 (#19520)
    
    * copy old swagger to new folders
    
    * set api version to 2022-08-01
    
    * apply api changes
    
    Co-authored-by: Gigi Grajo <gigigrajo@microsoft.com>
    
    * update appconfiguration (#19330)
    
    * update appconfiguration
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * [Hub Generated] Publish private branch 'main' (#19852)
    
    * Add StorageMover specification for PubliC Preview
    
    * SpellCheck fix
    
    * Update custom-words
    
    * Update specification/storagemover/resource-manager/readme.md
    
    Co-authored-by: Abhishek Krishna <abkrish@microsoft.com>
    Co-authored-by: Dapeng Zhang <dapzhang@microsoft.com>
    
    * Merging Dynatrace swagger in stable folder (#19862)
    
    * Committing base swagger version
    
    * Removing preview tag from stable folder api version
    
    * Changing version name in all the files
    
    * Updating readme.go and readme.md files
    
    * [CDN] Fix customDomains property type in Endpoint (#19788)
    
    * [CDN] Fix customDomains property type in Endpoint
    
    * Fix linter error
    
    Co-authored-by: Bo Zhang <bzhan@microsoft.com>
    
    * Adding Microsoft.Sql AdvancedThreatProtectionSettings APIs for MI on v5 tag for 2022-02-01-preview (#19866)
    
    * update folders
    
    * [Hub Generated] Review request for Microsoft.KeyVault to add version stable/7.3 (#19844)
    
    * Update description of exportable attribute and release_policy.data
    
    * Remove submodule azure-reset-api-specs
    
    * Fix description for exportable
    
    Co-authored-by: Sunny Solanki <Sunny.Solanki@microsoft.com>
    
    * Add latest StorageMover updates (#19876)
    
    * Add StorageMover specification for PubliC Preview
    
    * SpellCheck fix
    
    * Update custom-words
    
    * Update specification/storagemover/resource-manager/readme.md
    
    * Add latest StorageMover updates
    
    Co-authored-by: Abhishek Krishna <abkrish@microsoft.com>
    Co-authored-by: Dapeng Zhang <dapzhang@microsoft.com>
    
    * Update readme.python.md (#19899)
    
    * Update readme.python.md
    
    * Update readme.md
    
    * Moving files from azure-rest-spec-pr to azure-rest-spec repo after api review (#19878)
    
    * Moving files from azure-rest-spec-pr to azure-rest-spec repo after api review
    
    * Add known words
    
    * Removed static IP allocation only from examples (#19858)
    
    * Removed static IP allocation
    
    * Removed static only from examples
    
    Co-authored-by: Arpit Gagneja <argagnej@microsoft.com>
    
    * Update securityinsights readme.python (#19903)
    
    * update securityinsights readme.python
    
    * Update readme.python.md
    
    Co-authored-by: Zhenbiao Wei (WICRESOFT NORTH AMERICA LTD) <v-zhenbwei@microsoft.com>
    
    * fix lint errors in Synapse trigger.json (#19660)
    
    * put json files into RP folders
    
    * update readme
    
    * Add CONTRIBUTING.md (#19257)
    
    * Add CONTRIBUTING.md
    
    * Apply suggestions from PR review
    
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    
    * Apply suggestions from PR review
    
    Co-authored-by: Weidong Xu <weidxu@microsoft.com>
    
    * Regen toc for CONTRIBUTING.md
    
    * Address PR review comments
    
    * Address PR review comments
    
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    Co-authored-by: Weidong Xu <weidxu@microsoft.com>
    
    * fix devcenter readme.go.md config (#19906)
    
    * fix readme.go.md config
    
    * rename to SkuInfo
    
    * add annotation for labservices (#19884)
    
    * add to description of OS state (#19764)
    
    * [Hub Generated] Review request for Microsoft.KeyVault to add version preview/2021-06-01-preview (#19767)
    
    * Updated the managed hsm resource manager spec to include two additional properties for private endpoint connection item
    
    * Update managed hsm private endpoint connection item in mhsm spec for latest api version
    
    * Address LRO_RESPONSE_HEADER violation for managed hsm
    
    Long running operations that are annotated with x-ms-long-running-operation:true
    must return location header or azure-AsyncOperation in response.
    Added the missing location header for managed hsm update command as well as to the corresponding
    examples.
    
    * [Microsoft.DeviceUpdate] Adding first stable API version (#19846)
    
    * Copied the most recent preview version into the first stable version
    
    * Updated api version in new stable version, added the tag to readme.md
    
    * Fixed typo
    
    * Fixed the wrong path in readme.md
    
    * Reverted VS Code automatic breaking change
    
    * Fix broken link (#19688)
    
    * add aadObjectId property to kustoPool (#19856)
    
    Co-authored-by: Amit Elran <amelran@microsoft.com>
    
    * Updata securityinsights readme.python (#19917)
    
    * update securityinsights readme.python
    
    * update readme.python
    
    Co-authored-by: Zhenbiao Wei (WICRESOFT NORTH AMERICA LTD) <v-zhenbwei@microsoft.com>
    
    * modify readme.typescripy.md for compute package (#19607)
    
    Co-authored-by: ZiWei Chen (WICRESOFT NORTH AMERICA LTD) <v-ziweichen@microsoft.com>
    
    * Dev gubalasu frontdoor microsoft.network 2021 06 01 (#19578)
    
    * Adds base for updating Microsoft.Network from version stable/2020-05-01 to version 2021-06-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * update waf configs and examples from 2020-11-01
    
    * Update api version in new specs and examples
    
    * Migration api update
    
    * Update readme
    
    * Fix readme
    
    * update readme
    
    * Fix readme again
    
    * Fix readme
    
    * Fix readme
    
    * update waf policy provisioning state
    
    * Update securityinsights readme.python (#19923)
    
    * update securityinsights readme.python
    
    * update readme.python
    
    * last modify
    
    * Update readme.python.md
    
    Co-authored-by: Zhenbiao Wei (WICRESOFT NORTH AMERICA LTD) <v-zhenbwei@microsoft.com>
    
    * sync with changes made to master
    
    * update folder structure
    
    * small errors and CI check
    
    * update folders
    
    * put json files into RP folders
    
    * update readme
    
    * resolve capitalization and number misplacement accident
    
    Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com>
    Co-authored-by: Deyaaeldeen Almahallawi <dealmaha@microsoft.com>
    Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com>
    Co-authored-by: Bin Xia <binxi@microsoft.com>
    Co-authored-by: Matt Stam <mattstam@live.com>
    Co-authored-by: Jianping Zeng <zjpjack@users.noreply.github.com>
    Co-authored-by: Or Parnes <orparnes@microsoft.com>
    Co-authored-by: Alexander Batishchev <abatishchev@gmail.com>
    Co-authored-by: PatrickTseng <pattts@microsoft.com>
    Co-authored-by: gigi <52640944+gigigoo0@users.noreply.github.com>
    Co-authored-by: Gigi Grajo <gigigrajo@microsoft.com>
    Co-authored-by: zhenbiao wei <424401670@qq.com>
    Co-authored-by: Abhishek Krishna <AbhishekKrishna123@users.noreply.github.com>
    Co-authored-by: Abhishek Krishna <abkrish@microsoft.com>
    Co-authored-by: Dapeng Zhang <dapzhang@microsoft.com>
    Co-authored-by: Divyansh Agarwal <83802474+divyansh3131@users.noreply.github.com>
    Co-authored-by: t-bzhan <61817681+t-bzhan@users.noreply.github.com>
    Co-authored-by: Bo Zhang <bzhan@microsoft.com>
    Co-authored-by: Uriel Cohen <urielc@microsoft.com>
    Co-authored-by: susolank <73919400+susolank@users.noreply.github.com>
    Co-authored-by: Sunny Solanki <Sunny.Solanki@microsoft.com>
    Co-authored-by: Ralf Beckers <bexxx@users.noreply.github.com>
    Co-authored-by: arpit-gagneja <gagneja.arpit@gmail.com>
    Co-authored-by: Arpit Gagneja <argagnej@microsoft.com>
    Co-authored-by: Zhenbiao Wei (WICRESOFT NORTH AMERICA LTD) <v-zhenbwei@microsoft.com>
    Co-authored-by: YanjunGao <85206987+yanjungao718@users.noreply.github.com>
    Co-authored-by: Mike Kistler <mikekistler@microsoft.com>
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    Co-authored-by: Weidong Xu <weidxu@microsoft.com>
    Co-authored-by: Jiahui Peng <46921893+Alancere@users.noreply.github.com>
    Co-authored-by: j-zhong-ms <107880703+j-zhong-ms@users.noreply.github.com>
    Co-authored-by: Tom FitzMacken <tomfitz@microsoft.com>
    Co-authored-by: neeerajaakula <81248992+neeerajaakula@users.noreply.github.com>
    Co-authored-by: darkoa-msft <61987922+darkoa-msft@users.noreply.github.com>
    Co-authored-by: Roy Wellington <53838718+roy-work@users.noreply.github.com>
    Co-authored-by: Amit Elran <amitelran2110@gmail.com>
    Co-authored-by: Amit Elran <amelran@microsoft.com>
    Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com>
    Co-authored-by: ZiWei Chen (WICRESOFT NORTH AMERICA LTD) <v-ziweichen@microsoft.com>
    Co-authored-by: gubalasu <59630928+gubalasu@users.noreply.github.com>
    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 CI-BreakingChange-Go CI-BreakingChange-JavaScript FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants