Skip to content

Fix spelling in doc comments within Certificate client models.#4255

Merged
1 commit merged intoAzure:mainfrom
ahsonkhan:FixSpellingCert
Jan 17, 2023
Merged

Fix spelling in doc comments within Certificate client models.#4255
1 commit merged intoAzure:mainfrom
ahsonkhan:FixSpellingCert

Conversation

@ahsonkhan
Copy link
Contributor

@ahsonkhan ahsonkhan commented Jan 17, 2023

@ahsonkhan ahsonkhan added this to the 2023-02 milestone Jan 17, 2023
@ahsonkhan ahsonkhan self-assigned this Jan 17, 2023
@ghost
Copy link

ghost commented Jan 17, 2023

Hello @ahsonkhan!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

LarryOsterman
LarryOsterman approved these changes Jan 17, 2023
View reviewed changes
...security-keyvault-certificates/inc/azure/keyvault/certificates/certificate_client_models.hpp

/**
* @brief Content type of the certificate when downloaded from getecret.
* @brief Content type of the certificate when downloaded from getsecret.
Copy link
Member

@LarryOsterman LarryOsterman Jan 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be GetSecret instead of getsecret?

Copy link
Contributor Author

@ahsonkhan ahsonkhan Jan 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, ideally it should. Actually, from context, most likely it is supposed to be GetCertificate since CertificateClient doesn't have a GetSecret anyway.

Copy link
Contributor Author

@ahsonkhan ahsonkhan Jan 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this doc comment was incorrectly copied from .NET:
https://github.com/Azure/azure-sdk-for-net/blob/cb3e8630ab0df6609b5ff6643e5ea0700e4a9816/sdk/keyvault/Azure.Security.KeyVault.Certificates/src/CertificateContentType.cs#L10

Azure/azure-sdk-for-net#7530

Here's the corresponding swagger:
https://github.com/Azure/azure-rest-api-specs/blob/3e27c70e7c02c07b458bc0e94716c3d82d3fdd19/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.3/certificates.json#L1387

      "description": "The content type of the secret. eg. 'application/x-pem-file' or 'application/x-pkcs12', "

@schaabs and @vhvb1989 what is the correct/intended documentation here?

Copy link
Contributor Author

@ahsonkhan ahsonkhan Mar 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Filed an issue for this: #4394

@ghost ghost merged commit 4f7a0ea into Azure:main Jan 17, 2023
@ahsonkhan ahsonkhan deleted the FixSpellingCert branch January 17, 2023 19:57
@ahsonkhan ahsonkhan mentioned this pull request Mar 1, 2023
Closed
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@LarryOsterman LarryOsterman LarryOsterman approved these changes

@vhvb1989 vhvb1989 Awaiting requested review from vhvb1989

@gearama gearama Awaiting requested review from gearama

@antkmsft antkmsft Awaiting requested review from antkmsft

@RickWinter RickWinter Awaiting requested review from RickWinter RickWinter is a code owner

Assignees

@ahsonkhan ahsonkhan

Labels

KeyVault

Projects

None yet

Milestone

2023-02

Development

Successfully merging this pull request may close these issues.

2 participants

@ahsonkhan @LarryOsterman