Skip to content

Conversation

@ChenglongLiu
Copy link
Member

@ChenglongLiu ChenglongLiu commented Jun 7, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 7, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 7, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 4 Errors, 14 Warnings failed [Detail]
Compared specs (v0.10.9) new version base version
afdx.json 2024-05-01-preview(27679f3) 2024-02-01(main)
afdx.json 2024-05-01-preview(27679f3) 2023-07-01-preview(main)
cdn.json 2024-05-01-preview(27679f3) 2024-02-01(main)
cdn.json 2024-05-01-preview(27679f3) 2023-07-01-preview(main)
cdnwebapplicationfirewall.json 2024-05-01-preview(27679f3) 2024-02-01(main)
cdnwebapplicationfirewall.json 2024-05-01-preview(27679f3) 2023-07-01-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule Message
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: Microsoft.Cdn/preview/2024-05-01-preview/cdn.json#L3139:9
Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L2968:9
1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: Microsoft.Cdn/preview/2024-05-01-preview/cdn.json#L3279:9
Old: Microsoft.Cdn/stable/2024-02-01/cdn.json#L3107:9
1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L5381:7
Old: Microsoft.Cdn/stable/2024-02-01/afdx.json#L4926:7
1034 - AddedRequiredProperty The new version has new required property 'secretVersion' that was not found in the old version.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L5367:5
Old: Microsoft.Cdn/stable/2024-02-01/afdx.json#L4913:5


The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3584:13
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L3581:13
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3632:13
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L3629:13
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3561:9
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L3558:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3606:9
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L3603:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3649:9
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L3646:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'uuid' than the previous one ''.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3711:9
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L3716:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: Microsoft.Cdn/preview/2024-05-01-preview/cdn.json#L3139:9
Old: Microsoft.Cdn/preview/2023-07-01-preview/cdn.json#L2884:9
⚠️ 1023 - TypeFormatChanged The new version has a different format 'arm-id' than the previous one ''.
New: Microsoft.Cdn/preview/2024-05-01-preview/cdn.json#L3279:9
Old: Microsoft.Cdn/preview/2023-07-01-preview/cdn.json#L3023:9
⚠️ 1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L5381:7
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L5229:7
⚠️ 1034 - AddedRequiredProperty The new version has new required property 'secretVersion' that was not found in the old version.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L5367:5
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L5216:5
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3561:9
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L3558:9
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3606:9
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L3603:9
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3649:9
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L3646:9
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3711:9
Old: Microsoft.Cdn/preview/2023-07-01-preview/afdx.json#L3716:9
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-preview-2024-05 package-preview-2024-05(27679f3) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L3549
RPC-Get-V1-11


The following errors/warnings exist before current PR submission:

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

Rule Message
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L136
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L185
PostResponseCodes 202 response for a LRO POST operation must not have a response schema specified.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L292
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L347
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L357
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L406
ResourceNameRestriction The resource name parameter 'customDomainName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L406
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L458
RepeatedPathInfo The 'profileName' already appears in the path, please don't repeat it in the request body.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L473
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L521
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L530
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:certificateType.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L573
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L605
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L614
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L668
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L678
ResourceNameRestriction The resource name parameter 'customDomainName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L678
PostResponseCodes 200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L679
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L730
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L740
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L789
ResourceNameRestriction The resource name parameter 'endpointName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L789
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L841
RepeatedPathInfo The 'profileName' already appears in the path, please don't repeat it in the request body.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L856
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L913
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L988
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L997
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L1051
ResourceNameRestriction The resource name parameter 'profileName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L1061
ResourceNameRestriction The resource name parameter 'endpointName' should be defined with a 'pattern' restriction.
Location: Microsoft.Cdn/preview/2024-05-01-preview/afdx.json#L1061
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 7, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from 3d78b4fcb092a1697fe4ceb936665f7b5fc58a47. 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] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    cmderr	[automation_init.sh] npm notice
    cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
    cmderr	[automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
    cmderr	[automation_init.sh] npm notice To update run: npm install -g [email protected]
    cmderr	[automation_init.sh] npm notice
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️azure-mgmt-cdn [Preview SDK Changes]
    • azure_mgmt_cdn-2.0.0-py3-none-any.whl
    • azure-mgmt-cdn-2.0.0.zip
    info	[Changelog]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 3d78b4fcb092a1697fe4ceb936665f7b5fc58a47. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-cdn-generated [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-cdn-generated-1.0.0-beta.1-sources.jar
    • azure-resourcemanager-cdn-generated-1.0.0-beta.1.jar
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 3d78b4fcb092a1697fe4ceb936665f7b5fc58a47. 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
  • ️✔️sdk/resourcemanager/cdn/armcdn [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed in generating from 3d78b4fcb092a1697fe4ceb936665f7b5fc58a47. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  807 |  … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Cannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | it does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk artifact
  • Azure.ResourceManager.Cdn [Preview SDK Changes]
    info	[Changelog]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 3d78b4fcb092a1697fe4ceb936665f7b5fc58a47. 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	Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
  • ️✔️@azure/arm-cdn [Preview SDK Changes]
    • azure-arm-cdn-9.1.1.tgz
    info	[Changelog]
    error	N/A, this code can be deprecated.
️❌ azure-resource-manager-schemas failed [Detail]
  • Code Generator Failed in generating from 3d78b4fcb092a1697fe4ceb936665f7b5fc58a47. 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] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az'
    cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'...
    cmderr	[initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types'
    cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'...
    cmderr	[initScript.sh] npm notice
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
    cmderr	[initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
    cmderr	[initScript.sh] npm notice To update run: npm install -g [email protected]
    cmderr	[initScript.sh] npm notice
    error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
    warn	Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500
    cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
    cmderr	[generateScript.sh]            ^
    cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
    cmderr	[generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
    cmderr	[generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
    cmderr	[generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig.
    cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500:12)
    cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:504:19)
    cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:739:36)
    cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:955:32)
    cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43)
    cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)
    cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12)
    cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1203:32)
    cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:1019:12)
    cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12)
    error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
    warn	Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    error	ConfigError: the 'breakingChangesLabel' configuration is missing or is incorrect from the 'swagger_to_sdk_config.json file. Please correct the value or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    error	ConfigError: the 'breakingChangesLabel' configuration is missing or is incorrect from the 'swagger_to_sdk_config.json file. Please correct the value or report this issue through https://aka.ms/azsdk/support/specreview-channel.
️⚠️ azure-powershell warning [Detail]
  • ⚠️Warning in generating from 3d78b4fcb092a1697fe4ceb936665f7b5fc58a47. 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
    error	ConfigError: the 'breakingChangesLabel' configuration is missing or is incorrect from the 'swagger_to_sdk_config.json file. Please correct the value or report this issue through https://aka.ms/azsdk/support/specreview-channel.
  • ⚠️Az.cdn.DefaultTag [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 7, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/cdn/armcdn There is no API change compared with the previous version
JavaScript @azure/arm-cdn There is no API change compared with the previous version
Java azure-resourcemanager-cdn-generated https://apiview.dev/Assemblies/Review/a857fa609d3c43b09808544a49c0693b?revisionId=159b26ac95e1492793f690d91df5571f
Swagger Microsoft.Cdn https://apiview.dev/Assemblies/Review/903c889b8b1e4bf9bd097f6d66eb1cdd?revisionId=df00a92f5c7c437c9dd27e4a184c864a

@ChenglongLiu
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@ChenglongLiu
Copy link
Member Author

/pr RequestMerge

@ChenglongLiu
Copy link
Member Author

@razvanbadea-msft
Copy link
Member

Removing the MergeRequested label as this PR needs to be ARMSignedOff and obtain a BreakingChange Approval before being able to be merged. To unblock this PR, follow the process at aka.ms/brch.

@ChenglongLiu
Copy link
Member Author

ChenglongLiu commented Jun 11, 2024

@razvanbadea-msft The PR in private repo already got ARMSignedOff and Approved-OkToMerge tags, refer: https://github.com/Azure/azure-rest-api-specs-pr/pull/17753. Follow the process aka.ms/brch added BreakingChange-Approved-BugFix tag.

@ChenglongLiu ChenglongLiu added the BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior label Jun 11, 2024
@ChenglongLiu
Copy link
Member Author

The changes to the REST API definition are correcting the definition to accurately describe the service behavior,so bypass the review process by adding BreakingChange-Approved-BugFix.

  1. 1023 - TypeFormatChanged is introdued when the reviewer ask adding "format": "arm-id"
  2. 1025 - RequiredStatusChange and 1034 - AddedRequiredProperty are reuired change for correcting the definition to accurately describe the service behavior. The SecretVersion alway needed.

@ChenglongLiu
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@ChenglongLiu ChenglongLiu added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 13, 2024
@ms-bogdan-rotaru ms-bogdan-rotaru added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 14, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 14, 2024
@mentat9 mentat9 self-requested a review June 17, 2024 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants