Fix spelling in doc comments within Certificate client models. #4255
Conversation
ahsonkhan
requested review from
LarryOsterman,
RickWinter,
antkmsft,
gearama and
vhvb1989
as code owners
|
Hello @ahsonkhan! Because this pull request has the 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 (
|
|
|
||
| /** | ||
| * @brief Content type of the certificate when downloaded from getecret. | ||
| * @brief Content type of the certificate when downloaded from getsecret. |
There was a problem hiding this comment.
Should this be GetSecret instead of getsecret?
There was a problem hiding this comment.
Yep, ideally it should. Actually, from context, most likely it is supposed to be GetCertificate since CertificateClient doesn't have a GetSecret anyway.
There was a problem hiding this comment.
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
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?
...security-keyvault-certificates/inc/azure/keyvault/certificates/certificate_client_models.hpp
Show resolved
Hide resolved
ghost
merged commit 2 participants
Discovered in https://dev.azure.com/azure-sdk/public/_build/results?buildId=2120396&view=logs&jobId=a129effc-2dd1-54d1-fb5a-ad7bdc0e851d&j=a129effc-2dd1-54d1-fb5a-ad7bdc0e851d&t=ccad100f-2904-5913-2083-c525ad929a03 from #4134