Skip to content

Commit 7451e3a

Browse files
yoshi-automationsofisl
yoshi-automation
authored and
sofisl
committed
fix(recaptchaenterprise): update the API
#### recaptchaenterprise:v1 The following keys were changed: - resources.projects.resources.assessments.methods.create.parameters.parent.description - resources.projects.resources.firewallpolicies.methods.create.parameters.parent.description - resources.projects.resources.firewallpolicies.methods.patch.parameters.updateMask.description - resources.projects.resources.keys.methods.addIpOverride.description - resources.projects.resources.keys.methods.create.parameters.parent.description - resources.projects.resources.keys.methods.list.parameters.parent.description - resources.projects.resources.keys.methods.patch.parameters.updateMask.description - resources.projects.resources.keys.methods.removeIpOverride.description - schemas.GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest.properties.annotation.description - schemas.GoogleCloudRecaptchaenterpriseV1Event.properties.firewallPolicyEvaluation.description - schemas.GoogleCloudRecaptchaenterpriseV1FirewallAction.properties.block.description - schemas.GoogleCloudRecaptchaenterpriseV1FirewallAction.properties.includeRecaptchaScript.description - schemas.GoogleCloudRecaptchaenterpriseV1FirewallAction.properties.redirect.description - schemas.GoogleCloudRecaptchaenterpriseV1FirewallAction.properties.setHeader.description - schemas.GoogleCloudRecaptchaenterpriseV1FirewallAction.properties.substitute.description - schemas.GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction.description - schemas.GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment.properties.error.description - schemas.GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment.properties.firewallPolicy.description - schemas.GoogleCloudRecaptchaenterpriseV1IOSKeySettings.properties.appleDeveloperId.description - schemas.GoogleCloudRecaptchaenterpriseV1Metrics.properties.challengeMetrics.description - schemas.GoogleCloudRecaptchaenterpriseV1Metrics.properties.scoreMetrics.description - schemas.GoogleCloudRecaptchaenterpriseV1TestingOptions.properties.testingChallenge.description - schemas.GoogleCloudRecaptchaenterpriseV1TestingOptions.properties.testingScore.description - schemas.GoogleCloudRecaptchaenterpriseV1WafSettings.properties.wafService.enum - schemas.GoogleCloudRecaptchaenterpriseV1WafSettings.properties.wafService.enumDescriptions - schemas.GoogleCloudRecaptchaenterpriseV1WebKeySettings.properties.allowAllDomains.description - schemas.GoogleCloudRecaptchaenterpriseV1WebKeySettings.properties.challengeSecurityPreference.description
1 parent 34c7bcb commit 7451e3a

File tree

2 files changed

+55
-53
lines changed

2 files changed

+55
-53
lines changed

‎discovery/recaptchaenterprise-v1.json

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@
147147
],
148148
"parameters": {
149149
"parent": {
150-
"description": "Required. The name of the project in which the assessment will be created, in the format `projects/{project}`.",
150+
"description": "Required. The name of the project in which the assessment is created, in the format `projects/{project}`.",
151151
"location": "path",
152152
"pattern": "^projects/[^/]+$",
153153
"required": true,
@@ -179,7 +179,7 @@
179179
],
180180
"parameters": {
181181
"parent": {
182-
"description": "Required. The name of the project this policy will apply to, in the format `projects/{project}`.",
182+
"description": "Required. The name of the project this policy applies to, in the format `projects/{project}`.",
183183
"location": "path",
184184
"pattern": "^projects/[^/]+$",
185185
"required": true,
@@ -300,7 +300,7 @@
300300
"type": "string"
301301
},
302302
"updateMask": {
303-
"description": "Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields will be updated.",
303+
"description": "Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields are updated.",
304304
"format": "google-fieldmask",
305305
"location": "query",
306306
"type": "string"
@@ -350,7 +350,7 @@
350350
"keys": {
351351
"methods": {
352352
"addIpOverride": {
353-
"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.",
353+
"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.",
354354
"flatPath": "v1/projects/{projectsId}/keys/{keysId}:addIpOverride",
355355
"httpMethod": "POST",
356356
"id": "recaptchaenterprise.projects.keys.addIpOverride",
@@ -387,7 +387,7 @@
387387
],
388388
"parameters": {
389389
"parent": {
390-
"description": "Required. The name of the project in which the key will be created, in the format `projects/{project}`.",
390+
"description": "Required. The name of the project in which the key is created, in the format `projects/{project}`.",
391391
"location": "path",
392392
"pattern": "^projects/[^/]+$",
393393
"required": true,
@@ -501,7 +501,7 @@
501501
"type": "string"
502502
},
503503
"parent": {
504-
"description": "Required. The name of the project that contains the keys that will be listed, in the format `projects/{project}`.",
504+
"description": "Required. The name of the project that contains the keys that is listed, in the format `projects/{project}`.",
505505
"location": "path",
506506
"pattern": "^projects/[^/]+$",
507507
"required": true,
@@ -597,7 +597,7 @@
597597
"type": "string"
598598
},
599599
"updateMask": {
600-
"description": "Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated.",
600+
"description": "Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields are updated.",
601601
"format": "google-fieldmask",
602602
"location": "query",
603603
"type": "string"
@@ -615,7 +615,7 @@
615615
]
616616
},
617617
"removeIpOverride": {
618-
"description": "Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error will be returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error will be returned.",
618+
"description": "Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error is returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error is returned.",
619619
"flatPath": "v1/projects/{projectsId}/keys/{keysId}:removeIpOverride",
620620
"httpMethod": "POST",
621621
"id": "recaptchaenterprise.projects.keys.removeIpOverride",
@@ -786,7 +786,7 @@
786786
}
787787
}
788788
},
789-
"revision": "20240825",
789+
"revision": "20240906",
790790
"rootUrl": "https://recaptchaenterprise.googleapis.com/",
791791
"schemas": {
792792
"GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": {
@@ -918,7 +918,7 @@
918918
"type": "string"
919919
},
920920
"annotation": {
921-
"description": "Optional. The annotation that will be 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.",
921+
"description": "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.",
922922
"enum": [
923923
"ANNOTATION_UNSPECIFIED",
924924
"LEGITIMATE",
@@ -1164,7 +1164,7 @@
11641164
"type": "boolean"
11651165
},
11661166
"firewallPolicyEvaluation": {
1167-
"description": "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.",
1167+
"description": "Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response.",
11681168
"type": "boolean"
11691169
},
11701170
"fraudPrevention": {
@@ -1249,23 +1249,23 @@
12491249
},
12501250
"block": {
12511251
"$ref": "GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction",
1252-
"description": "This action will deny access to a given page. The user will get an HTTP error code."
1252+
"description": "This action denies access to a given page. The user gets an HTTP error code."
12531253
},
12541254
"includeRecaptchaScript": {
12551255
"$ref": "GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction",
1256-
"description": "This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend."
1256+
"description": "This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend."
12571257
},
12581258
"redirect": {
12591259
"$ref": "GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction",
1260-
"description": "This action will redirect the request to a ReCaptcha interstitial to attach a token."
1260+
"description": "This action redirects the request to a reCAPTCHA interstitial to attach a token."
12611261
},
12621262
"setHeader": {
12631263
"$ref": "GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction",
1264-
"description": "This action will set a custom header but allow the request to continue to the customer backend."
1264+
"description": "This action sets a custom header but allow the request to continue to the customer backend."
12651265
},
12661266
"substitute": {
12671267
"$ref": "GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction",
1268-
"description": "This action will transparently serve a different page to an offending user."
1268+
"description": "This action transparently serves a different page to an offending user."
12691269
}
12701270
},
12711271
"type": "object"
@@ -1289,7 +1289,7 @@
12891289
"type": "object"
12901290
},
12911291
"GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction": {
1292-
"description": "A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token.",
1292+
"description": "A redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token.",
12931293
"id": "GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction",
12941294
"properties": {},
12951295
"type": "object"
@@ -1356,12 +1356,12 @@
13561356
"properties": {
13571357
"error": {
13581358
"$ref": "GoogleRpcStatus",
1359-
"description": "Output only. If the processing of a policy config fails, an error will be populated and the firewall_policy will be left empty.",
1359+
"description": "Output only. If the processing of a policy config fails, an error is populated and the firewall_policy is left empty.",
13601360
"readOnly": true
13611361
},
13621362
"firewallPolicy": {
13631363
"$ref": "GoogleCloudRecaptchaenterpriseV1FirewallPolicy",
1364-
"description": "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.",
1364+
"description": "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 is left empty.",
13651365
"readOnly": true
13661366
}
13671367
},
@@ -1514,7 +1514,7 @@
15141514
},
15151515
"appleDeveloperId": {
15161516
"$ref": "GoogleCloudRecaptchaenterpriseV1AppleDeveloperId",
1517-
"description": "Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA Enterprise to get a better assessment of the integrity of your app."
1517+
"description": "Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app."
15181518
}
15191519
},
15201520
"type": "object"
@@ -1689,7 +1689,7 @@
16891689
"id": "GoogleCloudRecaptchaenterpriseV1Metrics",
16901690
"properties": {
16911691
"challengeMetrics": {
1692-
"description": "Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data.",
1692+
"description": "Metrics are continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have challenge-based data.",
16931693
"items": {
16941694
"$ref": "GoogleCloudRecaptchaenterpriseV1ChallengeMetrics"
16951695
},
@@ -1701,7 +1701,7 @@
17011701
"type": "string"
17021702
},
17031703
"scoreMetrics": {
1704-
"description": "Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.",
1704+
"description": "Metrics are continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.",
17051705
"items": {
17061706
"$ref": "GoogleCloudRecaptchaenterpriseV1ScoreMetrics"
17071707
},
@@ -2010,7 +2010,7 @@
20102010
"id": "GoogleCloudRecaptchaenterpriseV1TestingOptions",
20112011
"properties": {
20122012
"testingChallenge": {
2013-
"description": "Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.",
2013+
"description": "Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.",
20142014
"enum": [
20152015
"TESTING_CHALLENGE_UNSPECIFIED",
20162016
"NOCAPTCHA",
@@ -2024,7 +2024,7 @@
20242024
"type": "string"
20252025
},
20262026
"testingScore": {
2027-
"description": "Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.",
2027+
"description": "Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.",
20282028
"format": "float",
20292029
"type": "number"
20302030
}
@@ -2410,13 +2410,15 @@
24102410
"WAF_SERVICE_UNSPECIFIED",
24112411
"CA",
24122412
"FASTLY",
2413-
"CLOUDFLARE"
2413+
"CLOUDFLARE",
2414+
"AKAMAI"
24142415
],
24152416
"enumDescriptions": [
24162417
"Undefined WAF",
24172418
"Cloud Armor",
24182419
"Fastly",
2419-
"Cloudflare"
2420+
"Cloudflare",
2421+
"Akamai"
24202422
],
24212423
"type": "string"
24222424
}
@@ -2428,7 +2430,7 @@
24282430
"id": "GoogleCloudRecaptchaenterpriseV1WebKeySettings",
24292431
"properties": {
24302432
"allowAllDomains": {
2431-
"description": "Optional. If set to true, it means allowed_domains will not be enforced.",
2433+
"description": "Optional. If set to true, it means allowed_domains are not enforced.",
24322434
"type": "boolean"
24332435
},
24342436
"allowAmpTraffic": {
@@ -2443,7 +2445,7 @@
24432445
"type": "array"
24442446
},
24452447
"challengeSecurityPreference": {
2446-
"description": "Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.",
2448+
"description": "Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE.",
24472449
"enum": [
24482450
"CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED",
24492451
"USABILITY",

0 commit comments

Comments
 (0)