Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[keyvault] fix doc comments #21410

Merged
merged 3 commits into from
Aug 22, 2023
Merged

[keyvault] fix doc comments #21410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
37085a2
update keys
gracewilcox Aug 21, 2023
d2ff1fd
update certs
gracewilcox Aug 21, 2023
337cc2d
charles fix
gracewilcox Aug 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sdk/security/keyvault/azadmin/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Release History

### 1.0.1 (2023-08-21)
### 1.0.1 (2023-08-22)

#### Other Changes
* Upgraded dependencies
Expand Down
7 changes: 7 additions & 0 deletions sdk/security/keyvault/azcertificates/autorest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, "");
```
2 changes: 1 addition & 1 deletion sdk/security/keyvault/azcertificates/constants.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdk/security/keyvault/azcertificates/models.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdk/security/keyvault/azkeys/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release History

## 1.0.1 (2023-08-21)
## 1.0.1 (2023-08-22)

### Other Changes
* Upgraded dependencies
Expand Down
14 changes: 14 additions & 0 deletions sdk/security/keyvault/azkeys/autorest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, "");
```
5 changes: 2 additions & 3 deletions sdk/security/keyvault/azkeys/constants.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdk/security/keyvault/azkeys/example_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
14 changes: 7 additions & 7 deletions sdk/security/keyvault/azkeys/models.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions sdk/security/keyvault/azkeys/response_types.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdk/security/keyvault/azsecrets/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release History

## 1.0.1 (2023-08-21)
## 1.0.1 (2023-08-22)

### Other Changes
* Upgraded dependencies
Expand Down