azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

TSP conversion of Microsoft.StorageActions

Open Alancere opened this issue 1 year ago • 6 comments

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.

diagram

Click here to see the details of Step 1

Breaking changes review (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you, you must follow the breaking changes process.
IMPORTANT This applies even if:

  • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
  • You believe there is no need for you to request breaking change approval, for any reason. Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.
Click here to see the diagram footnotes

Diagram footnotes

[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page. If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested is removed from your PR. This should cause the label WaitForARMFeedback to be added. [2] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • [ ] New API version. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • [ ] Update existing version to fix swagger quality issues in S360.
  • [ ] Other, please clarify:
    • edit this with your clarification

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 Swagger-Suppression-Process 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.
  • 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.
  • 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.

Alancere avatar Jan 18 '24 09:01 Alancere

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has at least one breaking change from a previous GA version (label: BreakingChangeReviewRequired). See the PR description for help.
  • ❌ The required check named TypeSpec Validation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

Swagger Validation Report

️❌BreakingChange: 43 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
storageactions.json 2023-01-01(300a356) 2023-01-01(main)

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

Rule Message
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'StorageTaskName' removed or renamed?
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1244:3
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1079:3
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L819:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L673:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L830:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L697:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L834:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L708:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1023:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L582:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L383:11
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L230:11
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L159:13
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L297:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L201:13
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L339:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L599:13
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L390:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L540:13
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L447:13
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1147:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L875:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1175:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L911:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L960:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1047:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L805:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L737:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L685:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L757:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1072:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L789:9
1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L797:7
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L727:7
1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L677:7
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L747:7
1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1064:7
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L779:7
1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L798:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L728:9
1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L805:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L737:9
1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L678:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L748:9
1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L685:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L757:9
1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1147:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L875:9
1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1065:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L780:9
1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1072:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L789:9
1029 - ReadonlyPropertyChanged The read only property has changed from 'true' to 'false'.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L960:9
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L1047:9
1034 - AddedRequiredProperty The new version has new required property 'value' that was not found in the old version.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L159:13
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L297:13
1034 - AddedRequiredProperty The new version has new required property 'value' that was not found in the old version.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L201:13
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L339:13
1034 - AddedRequiredProperty The new version has new required property 'value' that was not found in the old version.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L599:13
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L390:13
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️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?

Swagger Generation Artifacts

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

Breaking Changes Tracking



️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed [Logs] Generate from e784dd5a4f63b13b2630edc18b95c59ffa190104. 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
    warn		specification/storageactions/StorageActions.Management/tspconfig.yaml skipped due to azure-sdk-for-net-track2 not found in tspconfig.yaml
    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] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1m 714 | [0m         [36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1m     | [31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m     | [31;1mFailed to build sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1m 714 | [0m         [36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1m     | [31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m     | [31;1mFailed to packe sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1mGet-ChildItem: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1m 807 | [0m … rtifacts += [36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1m     | [31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m     | [31;1mCannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1m     | [31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1m     | [31;1mit does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1m 714 | [0m         [36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [36;1m     | [31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m     | [31;1mFailed to generate sdk artifact
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [0m
  • Azure.ResourceManager.Storageactions [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from e784dd5a4f63b13b2630edc18b95c59ffa190104. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    warn		specification/storageactions/StorageActions.Management/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh]  New minor version of npm available! 10.2.3 -> 10.4.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-storageactions [View full logs]  [Preview SDK Changes]
    info	[Changelog]   - Initial Release
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from e784dd5a4f63b13b2630edc18b95c59ffa190104. 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
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.2
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.2
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh]   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
    cmderr	[init.sh]                                  Dload  Upload   Total   Spent    Left  Speed
    cmderr	[init.sh] 
      0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     00   168k      0 --:--:-- --:--:-- --:--:--  168k
    cmderr	[init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz...
    cmderr	[init.sh] Computing checksum with sha256sum
    cmderr	[init.sh] Checksums matched!
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-storageactions [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from e784dd5a4f63b13b2630edc18b95c59ffa190104. 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
    warn		specification/storageactions/StorageActions.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/storageactions/armstorageactions [View full logs]  [Preview SDK Changes]
    info	[Changelog] This is a new package
    info	[Changelog]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from e784dd5a4f63b13b2630edc18b95c59ffa190104. 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-storageactions [View full logs]  [Preview SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
Posted by Swagger Pipeline | How to fix these errors?

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

we no more ask TSP for new service before releasing SDKs. ARM is asking TSP as a requirement from Mar 29 2024. I will close the PR directly.

josefree avatar Mar 07 '24 00:03 josefree