From dd2bbcd15d95bdf036bdd0c7abda4b6d695317c3 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 29 Aug 2024 14:43:29 -0700 Subject: [PATCH] docs: [recaptchaenterprise] minor doc fixes (#5646) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: minor doc fixes PiperOrigin-RevId: 668754916 Source-Link: https://github.com/googleapis/googleapis/commit/b99f12ae81cdfa330817274aed2b272e0c57c1c5 Source-Link: https://github.com/googleapis/googleapis-gen/commit/43ba3fad89f71737dc1c561b3d8b5ca4585fe5b8 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJlY2FwdGNoYWVudGVycHJpc2UvLk93bEJvdC55YW1sIiwiaCI6IjQzYmEzZmFkODlmNzE3MzdkYzFjNTYxYjNkOGI1Y2E0NTg1ZmU1YjgifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- .../v1/recaptchaenterprise.proto | 34 +++++++++---------- .../v1beta1/recaptchaenterprise.proto | 4 +-- ..._enterprise_service.annotate_assessment.js | 2 +- ...ha_enterprise_service.create_assessment.js | 2 +- ...recaptcha_enterprise_service.create_key.js | 2 +- .../recaptcha_enterprise_service.list_keys.js | 2 +- ...terprise_service.update_firewall_policy.js | 2 +- ...recaptcha_enterprise_service.update_key.js | 2 +- ...a_google.cloud.recaptchaenterprise.v1.json | 2 +- ...se_service_v1_beta1.annotate_assessment.js | 2 +- ...rise_service_v1_beta1.create_assessment.js | 2 +- .../v1/recaptcha_enterprise_service_client.ts | 18 +++++----- ...tcha_enterprise_service_v1_beta1_client.ts | 4 +-- 13 files changed, 39 insertions(+), 39 deletions(-) diff --git a/packages/google-cloud-recaptchaenterprise/protos/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto b/packages/google-cloud-recaptchaenterprise/protos/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto index 45c1523edfd..6048f012c49 100644 --- a/packages/google-cloud-recaptchaenterprise/protos/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto +++ b/packages/google-cloud-recaptchaenterprise/protos/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/packages/google-cloud-recaptchaenterprise/protos/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto b/packages/google-cloud-recaptchaenterprise/protos/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto index 00286834482..c1db3402c74 100644 --- a/packages/google-cloud-recaptchaenterprise/protos/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto +++ b/packages/google-cloud-recaptchaenterprise/protos/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/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.annotate_assessment.js b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.annotate_assessment.js index 386c3465228..a29d3fe6be8 100644 --- a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.annotate_assessment.js +++ b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.annotate_assessment.js @@ -34,7 +34,7 @@ function main(name) { */ // const name = 'abc123' /** - * 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. */ diff --git a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_assessment.js b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_assessment.js index 60eb442eeb8..84f95b89b16 100644 --- a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_assessment.js +++ b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_assessment.js @@ -29,7 +29,7 @@ function main(parent, assessment) { * TODO(developer): Uncomment these variables before running the sample. */ /** - * 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}`. */ // const parent = 'abc123' diff --git a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_key.js b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_key.js index 3ed70706576..19bfe8bf1f8 100644 --- a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_key.js +++ b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.create_key.js @@ -29,7 +29,7 @@ function main(parent, key) { * TODO(developer): Uncomment these variables before running the sample. */ /** - * 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}`. */ // const parent = 'abc123' diff --git a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.list_keys.js b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.list_keys.js index 014617591cb..e06e6766b22 100644 --- a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.list_keys.js +++ b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.list_keys.js @@ -29,7 +29,7 @@ function main(parent) { * TODO(developer): Uncomment these variables before running the sample. */ /** - * 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}`. */ // const parent = 'abc123' diff --git a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.update_firewall_policy.js b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.update_firewall_policy.js index 5940e9d0378..9af5834582b 100644 --- a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.update_firewall_policy.js +++ b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.update_firewall_policy.js @@ -34,7 +34,7 @@ function main(firewallPolicy) { // const firewallPolicy = {} /** * 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. */ // const updateMask = {} diff --git a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.update_key.js b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.update_key.js index 399cf5dea98..90b623ec6da 100644 --- a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.update_key.js +++ b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/recaptcha_enterprise_service.update_key.js @@ -34,7 +34,7 @@ function main(key) { // const key = {} /** * 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. */ // const updateMask = {} diff --git a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/snippet_metadata_google.cloud.recaptchaenterprise.v1.json b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/snippet_metadata_google.cloud.recaptchaenterprise.v1.json index 9a00e4bbd2c..ce4cd9b3763 100644 --- a/packages/google-cloud-recaptchaenterprise/samples/generated/v1/snippet_metadata_google.cloud.recaptchaenterprise.v1.json +++ b/packages/google-cloud-recaptchaenterprise/samples/generated/v1/snippet_metadata_google.cloud.recaptchaenterprise.v1.json @@ -419,7 +419,7 @@ "regionTag": "recaptchaenterprise_v1_generated_RecaptchaEnterpriseService_AddIpOverride_async", "title": "RecaptchaEnterpriseService addIpOverride Sample", "origin": "API_DEFINITION", - "description": " 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.", + "description": " 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 is returned.", "canonical": true, "file": "recaptcha_enterprise_service.add_ip_override.js", "language": "JAVASCRIPT", diff --git a/packages/google-cloud-recaptchaenterprise/samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.annotate_assessment.js b/packages/google-cloud-recaptchaenterprise/samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.annotate_assessment.js index 39047f28556..20040850ab6 100644 --- a/packages/google-cloud-recaptchaenterprise/samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.annotate_assessment.js +++ b/packages/google-cloud-recaptchaenterprise/samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.annotate_assessment.js @@ -34,7 +34,7 @@ function main(name) { */ // const name = 'abc123' /** - * 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. */ diff --git a/packages/google-cloud-recaptchaenterprise/samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.create_assessment.js b/packages/google-cloud-recaptchaenterprise/samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.create_assessment.js index 4d249ab174a..3fd11fd3c25 100644 --- a/packages/google-cloud-recaptchaenterprise/samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.create_assessment.js +++ b/packages/google-cloud-recaptchaenterprise/samples/generated/v1beta1/recaptcha_enterprise_service_v1_beta1.create_assessment.js @@ -29,7 +29,7 @@ function main(parent, assessment) { * TODO(developer): Uncomment these variables before running the sample. */ /** - * 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}`. */ // const parent = 'abc123' diff --git a/packages/google-cloud-recaptchaenterprise/src/v1/recaptcha_enterprise_service_client.ts b/packages/google-cloud-recaptchaenterprise/src/v1/recaptcha_enterprise_service_client.ts index 147a307fb68..408044158d4 100644 --- a/packages/google-cloud-recaptchaenterprise/src/v1/recaptcha_enterprise_service_client.ts +++ b/packages/google-cloud-recaptchaenterprise/src/v1/recaptcha_enterprise_service_client.ts @@ -446,7 +446,7 @@ export class RecaptchaEnterpriseServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * 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}`. * @param {google.cloud.recaptchaenterprise.v1.Assessment} request.assessment * Required. The assessment details. @@ -549,7 +549,7 @@ export class RecaptchaEnterpriseServiceClient { * Required. The resource name of the Assessment, in the format * `projects/{project}/assessments/{assessment}`. * @param {google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation} [request.annotation] - * 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. * @param {number[]} [request.reasons] @@ -661,7 +661,7 @@ export class RecaptchaEnterpriseServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * 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}`. * @param {google.cloud.recaptchaenterprise.v1.Key} request.key * Required. Information to create a reCAPTCHA Enterprise key. @@ -951,7 +951,7 @@ export class RecaptchaEnterpriseServiceClient { * Required. The key to update. * @param {google.protobuf.FieldMask} [request.updateMask] * 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. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -1235,7 +1235,7 @@ export class RecaptchaEnterpriseServiceClient { * 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. * * @param {Object} request * The request object that will be sent. @@ -1632,7 +1632,7 @@ export class RecaptchaEnterpriseServiceClient { * Required. The policy to update. * @param {google.protobuf.FieldMask} [request.updateMask] * 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. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -1930,7 +1930,7 @@ export class RecaptchaEnterpriseServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * 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}`. * @param {number} [request.pageSize] * Optional. The maximum number of keys to return. Default is 10. Max limit is @@ -2030,7 +2030,7 @@ export class RecaptchaEnterpriseServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * 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}`. * @param {number} [request.pageSize] * Optional. The maximum number of keys to return. Default is 10. Max limit is @@ -2078,7 +2078,7 @@ export class RecaptchaEnterpriseServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * 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}`. * @param {number} [request.pageSize] * Optional. The maximum number of keys to return. Default is 10. Max limit is diff --git a/packages/google-cloud-recaptchaenterprise/src/v1beta1/recaptcha_enterprise_service_v1_beta1_client.ts b/packages/google-cloud-recaptchaenterprise/src/v1beta1/recaptcha_enterprise_service_v1_beta1_client.ts index 14dbdd842af..b52b16ac4b2 100644 --- a/packages/google-cloud-recaptchaenterprise/src/v1beta1/recaptcha_enterprise_service_v1_beta1_client.ts +++ b/packages/google-cloud-recaptchaenterprise/src/v1beta1/recaptcha_enterprise_service_v1_beta1_client.ts @@ -379,7 +379,7 @@ export class RecaptchaEnterpriseServiceV1Beta1Client { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * 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}`. * @param {google.cloud.recaptchaenterprise.v1beta1.Assessment} request.assessment * Required. The assessment details. @@ -482,7 +482,7 @@ export class RecaptchaEnterpriseServiceV1Beta1Client { * Required. The resource name of the Assessment, in the format * `projects/{project_number}/assessments/{assessment_id}`. * @param {google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation} [request.annotation] - * 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. * @param {number[]} [request.reasons]