Skip to content

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

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

Merged
1 commit merged into from
Jan 17, 2023
+9 −2
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions .vscode/cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,13 @@
"SECP"
]
},
{
"filename": "**/sdk/keyvault/azure-security-keyvault-certificates/inc/azure/keyvault/certificates/certificate_client_models.hpp",
"words": [
"SECG",
"SECP"
]
},
{
"filename": "**/sdk/core/azure-core/**",
"words": [
Expand Down
4 changes: 2 additions & 2 deletions ...urity-keyvault-certificates/inc/azure/keyvault/certificates/certificate_client_models.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Certificat
};

/**
* @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

*
*/
class CertificateContentType final {
Expand Down Expand Up @@ -977,7 +977,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Certificat
Azure::Nullable<std::string> Id;

/**
* @brief Organization Administators collection.
* @brief Organization Administrators collection.
*
*/
std::vector<AdministratorDetails> AdminDetails;
Expand Down