docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/iam_v1.iamPolicies.html b/docs/dyn/iam_v1.iamPolicies.html
index 4746c63..23d6ac0 100644
--- a/docs/dyn/iam_v1.iamPolicies.html
+++ b/docs/dyn/iam_v1.iamPolicies.html
@@ -75,76 +75,36 @@
<h1><a href="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.iamPolicies.html">iamPolicies</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#lintPolicy">lintPolicy(body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lints, or validates, an IAM policy. Currently checks the</p>
+<p class="firstline">Lints, or validates, an IAM policy. Currently checks the google.iam.v1.Binding.condition field, which contains a condition expression for a role binding. Successful calls to this method always return an HTTP `200 OK` status code, even if the linter detects an issue in the IAM policy.</p>
<p class="toc_element">
<code><a href="#queryAuditableServices">queryAuditableServices(body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns a list of services that allow you to opt into audit logs that are</p>
+<p class="firstline">Returns a list of services that allow you to opt into audit logs that are not generated by default. To learn more about audit logs, see the [Logging documentation](https://cloud.google.com/logging/docs/audit).</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="lintPolicy">lintPolicy(body=None, x__xgafv=None)</code>
- <pre>Lints, or validates, an IAM policy. Currently checks the
-google.iam.v1.Binding.condition field, which contains a condition
-expression for a role binding.
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
-Successful calls to this method always return an HTTP `200 OK` status code,
-even if the linter detects an issue in the IAM policy.
+<div class="method">
+ <code class="details" id="lintPolicy">lintPolicy(body=None, x__xgafv=None)</code>
+ <pre>Lints, or validates, an IAM policy. Currently checks the google.iam.v1.Binding.condition field, which contains a condition expression for a role binding. Successful calls to this method always return an HTTP `200 OK` status code, even if the linter detects an issue in the IAM policy.
Args:
body: object, The request body.
The object takes the form of:
{ # The request to lint a Cloud IAM policy object.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # google.iam.v1.Binding.condition object to be linted.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
+ "fullResourceName": "A String", # The full resource name of the policy this lint request is about. The name follows the Google Cloud Platform (GCP) resource format. For example, a GCP project with ID `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. The resource name is not used to read the policy instance from the Cloud IAM database. The candidate policy for lint has to be provided in the same request object.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # google.iam.v1.Binding.condition object to be linted.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
},
- "fullResourceName": "A String", # The full resource name of the policy this lint request is about.
- #
- # The name follows the Google Cloud Platform (GCP) resource format.
- # For example, a GCP project with ID `my-project` will be named
- # `//cloudresourcemanager.googleapis.com/projects/my-project`.
- #
- # The resource name is not used to read the policy instance from the Cloud
- # IAM database. The candidate policy for lint has to be provided in the same
- # request object.
}
x__xgafv: string, V1 error format.
@@ -155,25 +115,15 @@
Returns:
An object of the form:
- { # The response of a lint operation. An empty response indicates
- # the operation was able to fully execute and no lint issue was found.
+ { # The response of a lint operation. An empty response indicates the operation was able to fully execute and no lint issue was found.
"lintResults": [ # List of lint results sorted by `severity` in descending order.
{ # Structured response of a single validation unit.
- "fieldName": "A String", # The name of the field for which this lint result is about.
- #
- # For nested messages `field_name` consists of names of the embedded fields
- # separated by period character. The top-level qualifier is the input object
- # to lint in the request. For example, the `field_name` value
- # `condition.expression` identifies a lint result for the `expression` field
- # of the provided condition.
"severity": "A String", # The validation unit severity.
"level": "A String", # The validation unit level.
- "validationUnitName": "A String", # The validation unit name, for instance
- # "lintValidationUnits/ConditionComplexityCheck".
"debugMessage": "A String", # Human readable debug message associated with the issue.
- "locationOffset": 42, # 0-based character position of problematic construct within the object
- # identified by `field_name`. Currently, this is populated only for condition
- # expression.
+ "validationUnitName": "A String", # The validation unit name, for instance "lintValidationUnits/ConditionComplexityCheck".
+ "locationOffset": 42, # 0-based character position of problematic construct within the object identified by `field_name`. Currently, this is populated only for condition expression.
+ "fieldName": "A String", # The name of the field for which this lint result is about. For nested messages `field_name` consists of names of the embedded fields separated by period character. The top-level qualifier is the input object to lint in the request. For example, the `field_name` value `condition.expression` identifies a lint result for the `expression` field of the provided condition.
},
],
}</pre>
@@ -181,23 +131,14 @@
<div class="method">
<code class="details" id="queryAuditableServices">queryAuditableServices(body=None, x__xgafv=None)</code>
- <pre>Returns a list of services that allow you to opt into audit logs that are
-not generated by default.
-
-To learn more about audit logs, see the [Logging
-documentation](https://cloud.google.com/logging/docs/audit).
+ <pre>Returns a list of services that allow you to opt into audit logs that are not generated by default. To learn more about audit logs, see the [Logging documentation](https://cloud.google.com/logging/docs/audit).
Args:
body: object, The request body.
The object takes the form of:
{ # A request to get the list of auditable services for a resource.
- "fullResourceName": "A String", # Required. The full resource name to query from the list of auditable
- # services.
- #
- # The name follows the Google Cloud Platform resource format.
- # For example, a Cloud Platform project with id `my-project` will be named
- # `//cloudresourcemanager.googleapis.com/projects/my-project`.
+ "fullResourceName": "A String", # Required. The full resource name to query from the list of auditable services. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.
}
x__xgafv: string, V1 error format.
@@ -211,8 +152,7 @@
{ # A response containing a list of auditable services for a resource.
"services": [ # The auditable services for a resource.
{ # Contains information about an auditable service.
- "name": "A String", # Public name of the service.
- # For example, the service name for Cloud IAM is 'iam.googleapis.com'.
+ "name": "A String", # Public name of the service. For example, the service name for Cloud IAM is 'iam.googleapis.com'.
},
],
}</pre>