[keyvault] azkeys renames (#20892)

Azure · Jun 6, 2023 · 21c5900 · 21c5900
1 parent 16468eb
commit 21c5900
Show file tree

Hide file tree

Showing 13 changed files with 600 additions and 526 deletions.
diff --git a/sdk/security/keyvault/azkeys/CHANGELOG.md b/sdk/security/keyvault/azkeys/CHANGELOG.md
@@ -1,6 +1,33 @@
 # Release History
 
-## 1.0.0 (2023-05-11)
+## 0.12.0 (unreleased)
+
+### Breaking Changes
+
+* Renamed `GetRandomBytesRequest` to `GetRandomBytesParameters`
+* `ListDeletedKey` to `ListDeletedKeyProperties`
+* `ListKeys` to `ListKeyProperties`
+* `DeletedKeyBundle` to `DeletedKey`
+* `KeyBundle` to `KeyVaultKey`
+* `RestoreKeyParameters.KeyBundleBackup` to `RestoreKeyParameters.KeyBackup`
+* `DeletedKeyItem` to `DeletedKeyProperties`
+* `KeyItem` to `KeyProperties`
+* `DeletedKeyListResult` to `DeletedKeyPropertiesListResult`
+* `KeyListResult` `KeyPropertiesListResult`
+* `KeyOperationsParameters` to `KeyOperationParameters`
+* Changed `JSONWebKey.KeyOperations` from type []*string to []*KeyOperation
+* `ReleaseParameters.Enc` to `ReleaseParameters.Algorithm`
+* `KeyOperationParameters.AAD` to `KeyOperationParameters.AdditionalAuthenticatedData`
+* `KeyOperationParameters.Tag` to `KeyOperationParameters.AuthenticationTag`
+* `JSONWebKeyOperation` to `KeyOperation`
+* `JSONWebKeyCurveName` to `KeyCurveName`
+* `JSONWebKeyEncryptionAlgorithm` to `EncryptionAlgorithm`
+* `JSONWebKeySignatureAlgorithm` to `SignatureAlgorithm`
+* `JSONWebKeyType` to `KeyType`
+* Removed `DeletionRecoveryLevel` type
+* Removed `SignatureAlgorithmRSNULL` constant
+* Removed `KeyOperationExport` constant
+* Removed `MaxResults` option
 
 ### Other Changes
 * Updated dependencies

diff --git a/sdk/security/keyvault/azkeys/assets.json b/sdk/security/keyvault/azkeys/assets.json
@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "go",
   "TagPrefix": "go/security/keyvault/azkeys",
-  "Tag": "go/security/keyvault/azkeys_d9ce3682be"
+  "Tag": "go/security/keyvault/azkeys_afbe036428"
 }
diff --git a/sdk/security/keyvault/azkeys/autorest.md b/sdk/security/keyvault/azkeys/autorest.md
@@ -25,30 +25,6 @@ directive:
     where: $["x-ms-parameterized-host"]
     transform: $.parameters[0]["x-ms-parameter-location"] = "client"
 
-  # capitalize acronyms
-  - from: swagger-document
-    where: $.definitions.KeyImportParameters.properties.Hsm
-    transform: $["x-ms-client-name"] = "HSM"
-  - from: swagger-document
-    where: $.definitions..properties..iv
-    transform: $["x-ms-client-name"] = "IV"
-  - from: swagger-document
-    where: $.definitions..properties..kid
-    transform: $["x-ms-client-name"] = "KID"
-
-  # Maxresults -> MaxResults
-  - from: swagger-document
-    where: $.paths..parameters..[?(@.name=='maxresults')]
-    transform: $["x-ms-client-name"] = "MaxResults"
-
-  # keyName, keyVersion -> name, version
-  - from: swagger-document
-    where: $.paths..parameters..[?(@.name=='key-name')]
-    transform: $["x-ms-client-name"] = "name"
-  - from: swagger-document
-    where: $.paths..parameters..[?(@.name=='key-version')]
-    transform: $["x-ms-client-name"] = "version"
-
   # rename parameter models to match their methods
   - rename-model:
       from: KeyCreateParameters
@@ -74,17 +50,137 @@ directive:
   - rename-model:
       from: KeyVerifyParameters
       to: VerifyParameters
+  - rename-model:
+      from: GetRandomBytesRequest
+      to: GetRandomBytesParameters
 
   # rename paged operations from Get* to List*
   - rename-operation:
       from: GetDeletedKeys
-      to: ListDeletedKeys
+      to: ListDeletedKeyProperties
   - rename-operation:
       from: GetKeys
-      to: ListKeys
+      to: ListKeyProperties
   - rename-operation:
       from: GetKeyVersions
-      to: ListKeyVersions
+      to: ListKeyPropertiesVersions
+
+  # rename KeyItem and KeyBundle
+  - rename-model:
+      from: DeletedKeyBundle
+      to: DeletedKey
+  - rename-model:
+      from: KeyItem
+      to: KeyProperties
+  - rename-model:
+      from: DeletedKeyItem
+      to: DeletedKeyProperties
+  - rename-model:
+      from: DeletedKeyListResult
+      to: DeletedKeyPropertiesListResult
+  - rename-model:
+      from: KeyListResult
+      to: KeyPropertiesListResult
+  - from: swagger-document
+    where: $.definitions.RestoreKeyParameters.properties.value
+    transform: $["x-ms-client-name"] = "KeyBackup"
+
+  # Remove MaxResults parameter
+  - where: "$.paths..*"
+    remove-parameter:
+      in: query
+      name: maxresults
+
+  # KeyOps updates
+  - rename-model:
+      from: KeyOperationsParameters
+      to: KeyOperationParameters
+  - from: models.go
+    where: $
+    transform: return $.replace(/KeyOps \[\]\*string/, "KeyOps []*KeyOperation");
+
+  # fix capitalization
+  - from: swagger-document
+    where: $.definitions.ImportKeyParameters.properties.Hsm
+    transform: $["x-ms-client-name"] = "HSM"
+  - from: swagger-document
+    where: $.definitions..properties..iv
+    transform: $["x-ms-client-name"] = "IV"
+  - from: swagger-document
+    where: $.definitions..properties..kid
+    transform: $["x-ms-client-name"] = "KID"
+
+  # keyName, keyVersion -> name, version
+  - from: swagger-document
+    where: $.paths..parameters..[?(@.name=='key-name')]
+    transform: $["x-ms-client-name"] = "name"
+  - from: swagger-document
+    where: $.paths..parameters..[?(@.name=='key-version')]
+    transform: $["x-ms-client-name"] = "version"
+
+  # KeyEncryptionAlgorithm renames
+  - from: swagger-document
+    where: $.definitions.ReleaseParameters.properties.enc
+    transform: $["x-ms-client-name"] = "algorithm"
+
+  # rename KeyOperationsParameters fields
+  - from: swagger-document
+    where: $.definitions.KeyOperationParameters.properties.aad
+    transform: $["x-ms-client-name"] = "AdditionalAuthenticatedData"
+  - from: swagger-document
+    where: $.definitions.KeyOperationParameters.properties.tag
+    transform: $["x-ms-client-name"] = "AuthenticationTag"
+
+  # remove JSONWeb Prefix
+  - from: 
+      - models.go
+      - constants.go
+    where: $
+    transform: return $.replace(/JSONWebKeyOperation/g, "KeyOperation");
+  - from: 
+      - models.go
+      - constants.go
+    where: $
+    transform: return $.replace(/JSONWebKeyCurveName/g, "CurveName");
+  - from: 
+      - models.go
+      - constants.go
+    where: $
+    transform: return $.replace(/JSONWebKeyEncryptionAlgorithm/g, "EncryptionAlgorithm");
+  - from: 
+      - models.go
+      - constants.go
+    where: $
+    transform: return $.replace(/JSONWebKeySignatureAlgorithm/g, "SignatureAlgorithm");
+  - from: 
+      - models.go
+      - constants.go
+    where: $
+    transform: return $.replace(/JSONWebKeyType/g, "KeyType");
+
+  # remove DeletionRecoveryLevel type
+  - from: models.go
+    where: $
+    transform: return $.replace(/RecoveryLevel \*DeletionRecoveryLevel/g, "RecoveryLevel *string");
+  - from: constants.go
+    where: $
+    transform: return $.replace(/(?:\/\/.*\s)+type DeletionRecoveryLevel string/, "");
+  - from: constants.go
+    where: $
+    transform: return $.replace(/(?:\/\/.*\s)+func PossibleDeletionRecovery(?:.+\s)+\}/, "");
+  - from: constants.go
+    where: $
+    transform: return $.replace(/const \(\n\s\/\/ DeletionRecoveryLevel(?:.+\s)+\)/, "");
+
+  # delete SignatureAlgorithmRSNULL
+  - from: constants.go
+    where: $
+    transform: return $.replace(/.*(\bSignatureAlgorithmRSNULL\b).*/g, "");
+
+   # delete KeyOperationExport
+  - from: constants.go
+    where: $
+    transform: return $.replace(/.*(\bKeyOperationExport\b).*/g, "");
 
   # delete unused error models
   - from: models.go