docs: minor doc fixes

Google APIs · copybara-github · commit b99f12ae81cd · 2024-08-28T21:47:52.000-07:00
PiperOrigin-RevId: 668754916
diff --git a/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto b/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto
@@ -130,7 +130,7 @@ service RecaptchaEnterpriseService {
   // Adds an IP override to a key. The following restrictions hold:
   // * The maximum number of IP overrides per key is 100.
   // * For any conflict (such as IP already exists or IP part of an existing
-  //   IP range), an error will be returned.
+  //   IP range), an error is returned.
   rpc AddIpOverride(AddIpOverrideRequest) returns (AddIpOverrideResponse) {
     option (google.api.http) = {
       post: "/v1/{name=projects/*/keys/*}:addIpOverride"
@@ -239,7 +239,7 @@ service RecaptchaEnterpriseService {
 
 // The create assessment request message.
 message CreateAssessmentRequest {
-  // Required. The name of the project in which the assessment will be created,
+  // Required. The name of the project in which the assessment is created,
   // in the format `projects/{project}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
@@ -469,7 +469,7 @@ message AnnotateAssessmentRequest {
     }
   ];
 
-  // Optional. The annotation that will be assigned to the Event. This field can
+  // Optional. The annotation that is assigned to the Event. This field can
   // be left empty to provide reasons that apply to an event without concluding
   // whether the event is legitimate or fraudulent.
   Annotation annotation = 2 [(google.api.field_behavior) = OPTIONAL];
@@ -726,7 +726,7 @@ message Event {
       [deprecated = true, (google.api.field_behavior) = OPTIONAL];
 
   // Optional. Flag for a reCAPTCHA express request for an assessment without a
-  // token. If enabled, `site_key` must reference an Express site key.
+  // token. If enabled, `site_key` must reference an express key.
   bool express = 14 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. The URI resource the user requested that triggered an assessment.
@@ -744,12 +744,12 @@ message Event {
   repeated string headers = 11 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Flag for enabling firewall policy config assessment.
-  // If this flag is enabled, the firewall policy will be evaluated and a
-  // suggested firewall action will be returned in the response.
+  // If this flag is enabled, the firewall policy is evaluated and a
+  // suggested firewall action is returned in the response.
   bool firewall_policy_evaluation = 12 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Data describing a payment transaction to be assessed. Sending
-  // this data enables reCAPTCHA Enterprise Fraud Prevention and the
+  // this data enables reCAPTCHA Fraud Prevention and the
   // FraudPreventionAssessment component in the response.
   TransactionData transaction_data = 13
       [(google.api.field_behavior) = OPTIONAL];
@@ -1197,7 +1197,7 @@ message AccountDefenderAssessment {
 
 // The create key request message.
 message CreateKeyRequest {
-  // Required. The name of the project in which the key will be created, in the
+  // Required. The name of the project in which the key is created, in the
   // format `projects/{project}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
@@ -1212,7 +1212,7 @@ message CreateKeyRequest {
 
 // The list keys request message.
 message ListKeysRequest {
-  // Required. The name of the project that contains the keys that will be
+  // Required. The name of the project that contains the keys that are
   // listed, in the format `projects/{project}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
@@ -1270,7 +1270,7 @@ message UpdateKeyRequest {
   Key key = 1 [(google.api.field_behavior) = REQUIRED];
 
   // Optional. The mask to control which fields of the key get updated. If the
-  // mask is not present, all fields will be updated.
+  // mask is not present, all fields are updated.
   google.protobuf.FieldMask update_mask = 2
       [(google.api.field_behavior) = OPTIONAL];
 }
@@ -1350,7 +1350,7 @@ message UpdateFirewallPolicyRequest {
   FirewallPolicy firewall_policy = 1 [(google.api.field_behavior) = REQUIRED];
 
   // Optional. The mask to control which fields of the policy get updated. If
-  // the mask is not present, all fields will be updated.
+  // the mask is not present, all fields are updated.
   google.protobuf.FieldMask update_mask = 2
       [(google.api.field_behavior) = OPTIONAL];
 }
@@ -1444,11 +1444,11 @@ message Metrics {
   // Inclusive start time aligned to a day (UTC).
   google.protobuf.Timestamp start_time = 1;
 
-  // Metrics will be continuous and in order by dates, and in the granularity
+  // Metrics are continuous and in order by dates, and in the granularity
   // of day. All Key types should have score-based data.
   repeated ScoreMetrics score_metrics = 2;
 
-  // Metrics will be continuous and in order by dates, and in the granularity
+  // Metrics are continuous and in order by dates, and in the granularity
   // of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have
   // challenge-based data.
   repeated ChallengeMetrics challenge_metrics = 3;
@@ -1493,7 +1493,7 @@ message Key {
     // Settings for keys that can be used by iOS apps.
     IOSKeySettings ios_settings = 5;
 
-    // Settings for keys that can be used by reCAPTCHA Express.
+    // Settings specific to keys that can be used for reCAPTCHA Express.
     ExpressKeySettings express_settings = 11;
   }
 
@@ -1698,13 +1698,13 @@ message ChallengeMetrics {
 
 // Policy config assessment.
 message FirewallPolicyAssessment {
-  // Output only. If the processing of a policy config fails, an error will be
-  // populated and the firewall_policy will be left empty.
+  // Output only. If the processing of a policy config fails, an error is
+  // populated and the firewall_policy is left empty.
   google.rpc.Status error = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The policy that matched the request. If more than one policy
   // may match, this is the first match. If no policy matches the incoming
-  // request, the policy field will be left empty.
+  // request, the policy field is left empty.
   FirewallPolicy firewall_policy = 8
       [(google.api.field_behavior) = OUTPUT_ONLY];
 }
diff --git a/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_v1.yaml b/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_v1.yaml
@@ -10,7 +10,7 @@ documentation:
   summary: |-
     Help protect your website from fraudulent activity, spam, and abuse without
     creating friction.
-  overview: reCAPTCHA Enterprise Overview
+  overview: reCAPTCHA Overview
 
 authentication:
   rules:
diff --git a/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto b/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto
@@ -60,7 +60,7 @@ service RecaptchaEnterpriseServiceV1Beta1 {
 
 // The create assessment request message.
 message CreateAssessmentRequest {
-  // Required. The name of the project in which the assessment will be created,
+  // Required. The name of the project in which the assessment is created,
   // in the format `projects/{project_number}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
@@ -290,7 +290,7 @@ message AnnotateAssessmentRequest {
     }
   ];
 
-  // Optional. The annotation that will be assigned to the Event. This field can
+  // Optional. The annotation that is assigned to the Event. This field can
   // be left empty to provide reasons that apply to an event without concluding
   // whether the event is legitimate or fraudulent.
   Annotation annotation = 2 [(google.api.field_behavior) = OPTIONAL];
diff --git a/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_v1beta1.yaml b/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_v1beta1.yaml
@@ -10,7 +10,7 @@ documentation:
   summary: |-
     Help protect your website from fraudulent activity, spam, and abuse without
     creating friction.
-  overview: reCAPTCHA Enterprise Overview
+  overview: reCAPTCHA Overview
 
 authentication:
   rules:
