Skip to content

Commit

Permalink
docs: [google-cloud-recaptcha-enterprise] minor doc fixes (#13039)
Browse files Browse the repository at this point in the history
BEGIN_COMMIT_OVERRIDE
docs: minor doc fixes
END_COMMIT_OVERRIDE
- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 668754916

Source-Link:
googleapis/googleapis@b99f12a

Source-Link:
googleapis/googleapis-gen@43ba3fa
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJlY2FwdGNoYS1lbnRlcnByaXNlLy5Pd2xCb3QueWFtbCIsImgiOiI0M2JhM2ZhZDg5ZjcxNzM3ZGMxYzU2MWIzZDhiNWNhNDU4NWZlNWI4In0=

BEGIN_NESTED_COMMIT
feat: [google-cloud-recaptcha-enterprise] add AssessmentEnvironment for
CreateAssessement to explicitly describe the environment of the
assessment
PiperOrigin-RevId: 668000366

Source-Link:
googleapis/googleapis@14d1fe2

Source-Link:
googleapis/googleapis-gen@a53bb74
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJlY2FwdGNoYS1lbnRlcnByaXNlLy5Pd2xCb3QueWFtbCIsImgiOiJhNTNiYjc0YzBhMzExODYwYzcwMzE4NTA5ZGIxNzY3ZGZlYjVlNTgwIn0=
END_NESTED_COMMIT

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: ohmayr <omairnaveed@ymail.com>
  • Loading branch information
3 people committed Sep 3, 2024
1 parent c54700d commit 7e40c8c
Show file tree
Hide file tree
Showing 11 changed files with 98 additions and 51 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
AnnotateAssessmentResponse,
AppleDeveloperId,
Assessment,
AssessmentEnvironment,
ChallengeMetrics,
CreateAssessmentRequest,
CreateFirewallPolicyRequest,
Expand Down Expand Up @@ -102,6 +103,7 @@
"AnnotateAssessmentResponse",
"AppleDeveloperId",
"Assessment",
"AssessmentEnvironment",
"ChallengeMetrics",
"CreateAssessmentRequest",
"CreateFirewallPolicyRequest",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "1.22.0" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
AnnotateAssessmentResponse,
AppleDeveloperId,
Assessment,
AssessmentEnvironment,
ChallengeMetrics,
CreateAssessmentRequest,
CreateFirewallPolicyRequest,
Expand Down Expand Up @@ -99,6 +100,7 @@
"AnnotateAssessmentResponse",
"AppleDeveloperId",
"Assessment",
"AssessmentEnvironment",
"ChallengeMetrics",
"CreateAssessmentRequest",
"CreateFirewallPolicyRequest",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "1.22.0" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ async def sample_create_assessment():
message.
parent (:class:`str`):
Required. The name of the project in which the
assessment will be created, in the format
assessment is created, in the format
``projects/{project}``.
This corresponds to the ``parent`` field
Expand Down Expand Up @@ -471,7 +471,7 @@ async def sample_annotate_assessment():
on the ``request`` instance; if ``request`` is provided, this
should not be set.
annotation (:class:`google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation`):
Optional. The annotation that will be
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
Expand Down Expand Up @@ -587,8 +587,8 @@ async def sample_create_key():
request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]]):
The request object. The create key request message.
parent (:class:`str`):
Required. The name of the project in which the key will
be created, in the format ``projects/{project}``.
Required. The name of the project in which the key is
created, in the format ``projects/{project}``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -705,8 +705,7 @@ async def sample_list_keys():
The request object. The list keys request message.
parent (:class:`str`):
Required. The name of the project that contains the keys
that will be listed, in the format
``projects/{project}``.
that are listed, in the format ``projects/{project}``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1052,7 +1051,7 @@ async def sample_update_key():
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
Optional. The mask to control which
fields of the key get updated. If the
mask is not present, all fields will be
mask is not present, all fields are
updated.
This corresponds to the ``update_mask`` field
Expand Down Expand Up @@ -1316,7 +1315,7 @@ async def add_ip_override(
- 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.
existing IP range), an error is returned.
.. code-block:: python
Expand Down Expand Up @@ -1935,7 +1934,7 @@ async def sample_update_firewall_policy():
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
Optional. The mask to control which
fields of the policy get updated. If the
mask is not present, all fields will be
mask is not present, all fields are
updated.
This corresponds to the ``update_mask`` field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -829,7 +829,7 @@ def sample_create_assessment():
message.
parent (str):
Required. The name of the project in which the
assessment will be created, in the format
assessment is created, in the format
``projects/{project}``.
This corresponds to the ``parent`` field
Expand Down Expand Up @@ -953,7 +953,7 @@ def sample_annotate_assessment():
on the ``request`` instance; if ``request`` is provided, this
should not be set.
annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation):
Optional. The annotation that will be
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
Expand Down Expand Up @@ -1066,8 +1066,8 @@ def sample_create_key():
request (Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]):
The request object. The create key request message.
parent (str):
Required. The name of the project in which the key will
be created, in the format ``projects/{project}``.
Required. The name of the project in which the key is
created, in the format ``projects/{project}``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1181,8 +1181,7 @@ def sample_list_keys():
The request object. The list keys request message.
parent (str):
Required. The name of the project that contains the keys
that will be listed, in the format
``projects/{project}``.
that are listed, in the format ``projects/{project}``.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1523,7 +1522,7 @@ def sample_update_key():
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Optional. The mask to control which
fields of the key get updated. If the
mask is not present, all fields will be
mask is not present, all fields are
updated.
This corresponds to the ``update_mask`` field
Expand Down Expand Up @@ -1779,7 +1778,7 @@ def add_ip_override(
- 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.
existing IP range), an error is returned.
.. code-block:: python
Expand Down Expand Up @@ -2383,7 +2382,7 @@ def sample_update_firewall_policy():
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Optional. The mask to control which
fields of the policy get updated. If the
mask is not present, all fields will be
mask is not present, all fields are
updated.
This corresponds to the ``update_mask`` field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ def add_ip_override(
- 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.
existing IP range), an error is returned.
Returns:
Callable[[~.AddIpOverrideRequest],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ def add_ip_override(
- 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.
existing IP range), an error is returned.
Returns:
Callable[[~.AddIpOverrideRequest],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
AnnotateAssessmentResponse,
AppleDeveloperId,
Assessment,
AssessmentEnvironment,
ChallengeMetrics,
CreateAssessmentRequest,
CreateFirewallPolicyRequest,
Expand Down Expand Up @@ -89,6 +90,7 @@
"AnnotateAssessmentResponse",
"AppleDeveloperId",
"Assessment",
"AssessmentEnvironment",
"ChallengeMetrics",
"CreateAssessmentRequest",
"CreateFirewallPolicyRequest",
Expand Down
Loading

0 comments on commit 7e40c8c

Please sign in to comment.