github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Match doc comments to method names (#5440)

Browse Source 
* Match doc comments to method names

Fixes #4683
This commit is contained in:
Rick Winter 2024-03-15 13:42:28 -07:00 committed by GitHub
parent caa7ad7652
commit 9fbfd5784c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sdk/attestation/azure-security-attestation/inc/azure/attestation/attestation_client_models.hpp
View File

@ -498,7 +498,7 @@ namespace Azure { namespace Security { namespace Attestation { namespace Models
};
/**
* @brief Result of a SetPolicy or ResetPolicy operation.
* @brief Result of a SetAttestationPolicy or ResetAttestationPolicy operation.
*/
struct PolicyResult
{

2
sdk/attestation/azure-security-attestation/inc/azure/attestation/attestation_client_options.hpp
View File

@ -301,7 +301,7 @@ namespace Azure { namespace Security { namespace Attestation {
*/
struct SetPolicyOptions final
{
/** @brief Optional Signing Key which is used to sign the SetPolicy request.
/** @brief Optional Signing Key which is used to sign the SetAttestationPolicy request.
*/
Azure::Nullable<AttestationSigningKey> SigningKey;

4
sdk/attestation/azure-security-attestation/samples/policy/set_policy.cpp
View File

@ -76,8 +76,8 @@ authorizationrules
// To verify that the attestation service received the attestation policy, the service returns
// the SHA256 hash of the policy token which was sent ot the service. To simplify the customer
// experience of interacting with the SetPolicy APIs, CreateAttestationPolicyToken API will
// generate the same token that would be send to the service.
// experience of interacting with the SetAttestationPolicy APIs, CreateAttestationPolicyToken
// API will generate the same token that would be send to the service.
//
// To ensure that the token which was sent from the client matches the token which was received
// by the attestation service, the customer can call CreateAttestationPolicyToken and then

4
sdk/attestation/azure-security-attestation/samples/policy/set_sealed_policy.cpp
View File

@ -91,8 +91,8 @@ authorizationrules
// To verify that the attestation service received the attestation policy, the service returns
// the SHA256 hash of the policy token which was sent ot the service. To simplify the customer
// experience of interacting with the SetPolicy APIs, CreateAttestationPolicyToken API will
// generate the same token that would be send to the service.
// experience of interacting with the SetAttestationPolicy APIs, CreateAttestationPolicyToken
// API will generate the same token that would be send to the service.
//
// To ensure that the token which was sent from the client matches the token which was received
// by the attestation service, the customer can call CreateAttestationPolicyToken and then

6
sdk/attestation/azure-security-attestation/src/private/attestation_client_models_private.hpp
View File

@ -243,7 +243,8 @@ namespace Azure {
};
/**
* @brief Result of a GetPolicy, SetPolicy, or ResetPolicy operation.
* @brief Result of a GetAttestationPolicy, SetAttestationPolicy, or ResetAttestationPolicy
* operation.
*/
struct PolicyResult
{
@ -278,7 +279,8 @@ namespace Azure {
};
/**
* @brief Result of a GetPolicy, SetPolicy, or ResetPolicy operation.
* @brief Result of a GetAttestationPolicy, SetAttestationPolicy, or ResetAttestationPolicy
* operation.
*/
struct GetIsolatedModeCertificatesResult
{

10
sdk/attestation/azure-security-attestation/test/ut/policygetset_test.cpp
View File

@ -108,13 +108,13 @@ namespace Azure { namespace Security { namespace Attestation { namespace Test {
{
EXPECT_EQ(result.RawResponse->GetStatusCode(), Azure::Core::Http::HttpStatusCode::Ok);
// SetPolicy responses should have updated or reset the policy value.
// SetAttestationPolicy responses should have updated or reset the policy value.
if (policyToValidate)
{
EXPECT_EQ(PolicyModification::Updated, result.Value.Body.PolicyResolution);
// The attestation service only returns the PolicySigner and PolicySigningHash on
// SetPolicy calls, not ResetPolicy calls.
// SetAttestationPolicy calls, not ResetAttestationPolicy calls.
// Now check the policy signer if appropriate.
if (signingKey)
@ -363,20 +363,20 @@ namespace Azure { namespace Security { namespace Attestation { namespace Test {
break;
// Modify attestation policies using an unsecured attestation JWS. This exercises the
// SetPolicy and ResetPolicy APIs.
// SetAttestationPolicy and ResetAttestationPolicy APIs.
case TestCaseType::ModifyPolicyUnsecured:
ModifyPolicyUnsecuredTest();
break;
// Modify attestation policies using an ephemeral secured attestation JWS. This exercises the
// SetPolicy and ResetPolicy APIs.
// SetAttestationPolicy and ResetAttestationPolicy APIs.
case TestCaseType::ModifyPolicySecured:
ModifyPolicySecuredTest();
break;
// Modify attestation policies using a predefined signing key and certificate.
// The key and certificate were created at test resource creation time.
// Exercises the SetPolicy and ResetPolicy APIs.
// Exercises the SetAttestationPolicy and ResetAttestationPolicy APIs.
case TestCaseType::ModifyPolicyIsolated:
ModifyPolicyIsolatedTest(); // LIVE-ONLY test!
break;