Remove redundant "rotate" from Keys API #25714

heaths · 2023-09-07T22:02:12Z

Original goal was to properly document "Rotate" that Key Vault returned and "rotate" that Managed HSM returned (and was originally in the swagger), but that case-insensitively duplicative value caused issues with some code generators.

Reverts parts of #24475

Original goal was to properly document "Rotate" that Key Vault returned and "rotate" that Managed HSM returned (and was originally in the swagger), but that case-insensitively duplicative value caused issues with some code generators. Reverts parts of Azure#24475

openapi-pipeline-app · 2023-09-07T22:02:15Z

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

openapi-pipeline-app · 2023-09-07T22:02:16Z

Swagger Validation Report

️❌BreakingChange: 14 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
keys.json	7.3-preview(2ff0da7)	7.3-preview(main)
keys.json	7.4-preview.1(2ff0da7)	7.4-preview.1(main)
keys.json	7.5-preview.1(2ff0da7)	7.5-preview.1(main)
keys.json	7.3(2ff0da7)	7.3(main)
keys.json	7.4(2ff0da7)	7.4(main)
keys.json	2021-04-01-preview(2ff0da7)	2021-04-01-preview(main)
keys.json	2021-06-01-preview(2ff0da7)	2021-06-01-preview(main)
keys.json	2021-11-01-preview(2ff0da7)	2021-11-01-preview(main)
keys.json	2022-02-01-preview(2ff0da7)	2022-02-01-preview(main)
keys.json	2022-07-01(2ff0da7)	2022-07-01(main)
keys.json	2022-11-01(2ff0da7)	2022-11-01(main)
keysManagedHsm.json	2022-11-01(2ff0da7)	2022-11-01(main)
keys.json	2023-02-01(2ff0da7)	2023-02-01(main)
keysManagedHsm.json	2023-02-01(2ff0da7)	2023-02-01(main)

Rule	Message
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L2194:9 Old: Microsoft.KeyVault/preview/7.3-preview/keys.json#L2194:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/preview/7.4-preview.1/keys.json#L2222:9 Old: Microsoft.KeyVault/preview/7.4-preview.1/keys.json#L2222:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/preview/7.5-preview.1/keys.json#L2200:9 Old: Microsoft.KeyVault/preview/7.5-preview.1/keys.json#L2200:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/stable/7.3/keys.json#L2195:9 Old: Microsoft.KeyVault/stable/7.3/keys.json#L2195:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/stable/7.4/keys.json#L2195:9 Old: Microsoft.KeyVault/stable/7.4/keys.json#L2195:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/preview/2021-04-01-preview/keys.json#L594:9 Old: Microsoft.KeyVault/preview/2021-04-01-preview/keys.json#L594:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L612:9 Old: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L612:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/preview/2021-11-01-preview/keys.json#L612:9 Old: Microsoft.KeyVault/preview/2021-11-01-preview/keys.json#L612:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/preview/2022-02-01-preview/keys.json#L613:9 Old: Microsoft.KeyVault/preview/2022-02-01-preview/keys.json#L613:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/stable/2022-07-01/keys.json#L614:9 Old: Microsoft.KeyVault/stable/2022-07-01/keys.json#L614:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/stable/2022-11-01/keys.json#L614:9 Old: Microsoft.KeyVault/stable/2022-11-01/keys.json#L614:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L543:9 Old: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L543:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/stable/2023-02-01/keys.json#L614:9 Old: Microsoft.KeyVault/stable/2023-02-01/keys.json#L614:9
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'rotate' from the old version. New: Microsoft.KeyVault/stable/2023-02-01/keysManagedHsm.json#L543:9 Old: Microsoft.KeyVault/stable/2023-02-01/keysManagedHsm.json#L543:9

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️🔄LintDiff inProgress [Detail]

️️✔️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.

️️✔️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).

️️✔️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 · 2023-09-07T22:02:16Z

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 warning [Detail]

⚠️Warning [Logs]Release - Generate from 5dd1107. 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/keyvault/data-plane/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
warn	No file changes detected after generation

️✔️Azure.ResourceManager.KeyVault [View full logs]
- Azure.ResourceManager.KeyVault.1.2.0-alpha.20230913.1.nupkg
```
info	[Changelog]
```

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 5dd1107. 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.
warn		specification/keyvault/data-plane/readme.md skipped due to azure-sdk-for-python-track2 not found in swagger-to-sdk
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh] notice
cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.6.7 -> 10.1.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.1.0` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-keyvault [View full logs] [Release SDK Changes]
- azure_mgmt_keyvault-10.2.3-py3-none-any.whl
- azure-mgmt-keyvault-10.2.3.zip
```
info	[Changelog]
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 5dd1107. 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.2.1
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.2.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
warn		specification/keyvault/data-plane/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-keyvault-generated [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 5dd1107. 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/keyvault/data-plane/readme.md skipped due to azure-sdk-for-go not found in swagger-to-sdk
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/keyvault/armkeyvault [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New value `ManagedHsmSKUNameCustomB6` added to enum type `ManagedHsmSKUName`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 1 additive change(s).

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 5dd1107. 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
warn		specification/keyvault/data-plane/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk
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-keyvault [View full logs] [Release SDK Changes]

azure-arm-keyvault-3.0.1.tgz

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 5dd1107. 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] npm notice
cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.1.0
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.1.0` to update!
cmderr	[initScript.sh] npm notice
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
warn		specification/keyvault/data-plane/readme.md skipped due to azure-resource-manager-schemas not found in swagger-to-sdk
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json

️✔️keyvault [View full logs] [Release Schema Changes]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from 5dd1107. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
warn		specification/keyvault/data-plane/readme.md skipped due to azure-powershell not found in swagger-to-sdk
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

⚠️Az.keyvault.DefaultTag [View full logs]

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.keyvault.DefaultTag

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-09-07T22:02:17Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/keyvault/armkeyvault	https://apiview.dev/Assemblies/Review/474d590e09e94533a1245214ee66c607
.Net	Azure.ResourceManager.KeyVault	There is no API change compared with the previous version
Java	azure-resourcemanager-keyvault-generated	Create ApiView timeout. Package is too large and we cannot create ApiView for it.
JavaScript	@azure/arm-keyvault	https://apiview.dev/Assemblies/Review/2079ce6e9aff47cfaebbb995c33cf91a

openapi-workflow-bot · 2023-09-07T22:10:59Z

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.

heaths · 2023-09-11T21:56:49Z

Note to @rkmanda: this does revert one of the changes we discussed in #24475 and gets rid of "rotate". ARM clients and the related services are already case-insensitive in their requests and responses, so this shouldn't be a problem. It only was a problem for code generation, hence this change.

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json

heaths · 2023-09-12T21:12:09Z

@rkmanda could you take a look?

rkmanda

openapi-pipeline-app · 2023-09-13T23:38:21Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

* Remove redundant "rotate" from Keys API Original goal was to properly document "Rotate" that Key Vault returned and "rotate" that Managed HSM returned (and was originally in the swagger), but that case-insensitively duplicative value caused issues with some code generators. Reverts parts of #24475 * Remove now-unnecessary exemptions * Fix description on Notify

heaths requested a review from jlichwa as a code owner September 7, 2023 22:02

heaths requested review from vickm, daviddesberg and vcolin7 September 7, 2023 22:02

openapi-assignment-bot bot assigned heaths Sep 7, 2023

Remove now-unnecessary exemptions

a287b5f

azure-sdk mentioned this pull request Sep 7, 2023

[AutoPR sdk/resourcemanager/keyvault/armkeyvault] Remove redundant "rotate" from Keys API azure-sdk/azure-sdk-for-go#7229

Closed

heaths mentioned this pull request Sep 7, 2023

Align the casing of LifetimeActionsType with the service. #24475

Merged

3 tasks

azure-sdk mentioned this pull request Sep 7, 2023

[AutoPR @azure/arm-keyvault] Remove redundant "rotate" from Keys API azure-sdk/azure-sdk-for-js#6621

Closed

This was referenced Sep 7, 2023

[AutoPR azure-resourcemanager-keyvault-generated] Remove redundant "rotate" from Keys API azure-sdk/azure-sdk-for-java#6878

Closed

[AutoPR track2_azure-mgmt-keyvault] Remove redundant "rotate" from Keys API azure-sdk/azure-sdk-for-python#4608

Closed

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 7, 2023

vickm approved these changes Sep 8, 2023

View reviewed changes

jlichwa requested changes Sep 11, 2023

View reviewed changes

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json Outdated Show resolved Hide resolved

Fix description on Notify

2ff0da7

jlichwa approved these changes Sep 11, 2023

View reviewed changes

azure-sdk mentioned this pull request Sep 11, 2023

[AutoPR keyvault] Remove redundant "rotate" from Keys API azure-sdk/azure-resource-manager-schemas#3202

Closed

rkmanda approved these changes Sep 13, 2023

View reviewed changes

rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 13, 2023

openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 13, 2023

rkmanda merged commit 5dd1107 into Azure:main Sep 13, 2023
27 of 30 checks passed

heaths deleted the keyvault-revert-rotate-change branch September 13, 2023 23:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove redundant "rotate" from Keys API #25714

Remove redundant "rotate" from Keys API #25714

heaths commented Sep 7, 2023

openapi-pipeline-app bot commented Sep 7, 2023 •

edited

Loading

openapi-pipeline-app bot commented Sep 7, 2023 •

edited

Loading

openapi-pipeline-app bot commented Sep 7, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Sep 7, 2023 •

edited

Loading

openapi-workflow-bot bot commented Sep 7, 2023

heaths commented Sep 11, 2023

heaths commented Sep 12, 2023

rkmanda left a comment

openapi-pipeline-app bot commented Sep 13, 2023

Remove redundant "rotate" from Keys API #25714

Remove redundant "rotate" from Keys API #25714

Conversation

heaths commented Sep 7, 2023

openapi-pipeline-app bot commented Sep 7, 2023 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Sep 7, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Sep 7, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Sep 7, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Sep 7, 2023

heaths commented Sep 11, 2023

heaths commented Sep 12, 2023

rkmanda left a comment

Choose a reason for hiding this comment

openapi-pipeline-app bot commented Sep 13, 2023

openapi-pipeline-app bot commented Sep 7, 2023 •

edited

Loading

openapi-pipeline-app bot commented Sep 7, 2023 •

edited

Loading

openapi-pipeline-app bot commented Sep 7, 2023 •

edited

Loading

openapi-pipeline-app bot commented Sep 7, 2023 •

edited

Loading