[keyvault] fix doc comments (Azure#21410)

* update keys * update certs * charles fix
azure-sdk · Aug 22, 2023 · 446ca6b · 446ca6b
1 parent 46308d6
commit 446ca6b
Show file tree

Hide file tree

Showing 11 changed files with 38 additions and 18 deletions.
diff --git a/sdk/security/keyvault/azadmin/CHANGELOG.md b/sdk/security/keyvault/azadmin/CHANGELOG.md
@@ -1,6 +1,6 @@
 ## Release History
 
-### 1.0.1 (2023-08-21)
+### 1.0.1 (2023-08-22)
 
 #### Other Changes
 * Upgraded dependencies 

diff --git a/sdk/security/keyvault/azcertificates/autorest.md b/sdk/security/keyvault/azcertificates/autorest.md
@@ -246,4 +246,11 @@ directive:
   - from: swagger-document
     where: $.definitions.X509CertificateProperties.properties.key_usage.items
     transform: $["description"] = "Defines how the certificate's key may be used."
+
+  # remove redundant section of doc comment
+  - from:
+      - models.go
+      - constants.go
+    where: $
+    transform: return $.replace(/For valid values, see JsonWebKeyCurveName./g, "");
 ```
diff --git a/sdk/security/keyvault/azcertificates/constants.go b/sdk/security/keyvault/azcertificates/constants.go
diff --git a/sdk/security/keyvault/azcertificates/models.go b/sdk/security/keyvault/azcertificates/models.go
diff --git a/sdk/security/keyvault/azkeys/CHANGELOG.md b/sdk/security/keyvault/azkeys/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Release History
 
-## 1.0.1 (2023-08-21)
+## 1.0.1 (2023-08-22)
 
 ### Other Changes
 * Upgraded dependencies

diff --git a/sdk/security/keyvault/azkeys/autorest.md b/sdk/security/keyvault/azkeys/autorest.md
@@ -227,4 +227,18 @@ directive:
   - from: models.go
     where: $
     transform: return $.replace(/(KID \*)string(\s+.*)/g, "$1ID$2")
+
+  # edit doc comments to not contain DeletedKeyBundle
+  - from: 
+      - models.go
+      - response_types.go
+    where: $
+    transform: return $.replace(/DeletedKeyBundle/g, "DeletedKey")
+
+  # remove redundant section of doc comment
+  - from:
+      - models.go
+      - constants.go
+    where: $
+    transform: return $.replace(/(For valid values, (.*)\.)|(For more information .*\.)|(For more information on possible algorithm\n\/\/ types, see JsonWebKeySignatureAlgorithm.)/g, "");
 ```
diff --git a/sdk/security/keyvault/azkeys/constants.go b/sdk/security/keyvault/azkeys/constants.go
diff --git a/sdk/security/keyvault/azkeys/example_test.go b/sdk/security/keyvault/azkeys/example_test.go
@@ -119,7 +119,7 @@ func ExampleClient_UpdateKey() {
 // [Client.RotateKey] allows you to rotate a key on demand. See [Azure Key Vault documentation] for more information about key
 // rotation.
 //
-// [Azure Key Vault documentation]: https://docs.microsoft.com/azure/key-vault/keys/how-to-configure-key-rotation
+// [Azure Key Vault documentation]: https://learn.microsoft.com/azure/key-vault/keys/how-to-configure-key-rotation
 func ExampleClient_UpdateKeyRotationPolicy() {
 	// this policy rotates the key every 18 months
 	policy := azkeys.KeyRotationPolicy{

diff --git a/sdk/security/keyvault/azkeys/models.go b/sdk/security/keyvault/azkeys/models.go
diff --git a/sdk/security/keyvault/azkeys/response_types.go b/sdk/security/keyvault/azkeys/response_types.go
diff --git a/sdk/security/keyvault/azsecrets/CHANGELOG.md b/sdk/security/keyvault/azsecrets/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Release History
 
-## 1.0.1 (2023-08-21)
+## 1.0.1 (2023-08-22)
 
 ### Other Changes
 * Upgraded dependencies