docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/iam_v1.roles.html b/docs/dyn/iam_v1.roles.html
index 8b855e2..8d7d3e3 100644
--- a/docs/dyn/iam_v1.roles.html
+++ b/docs/dyn/iam_v1.roles.html
@@ -75,53 +75,35 @@
<h1><a href="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.roles.html">roles</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the definition of a Role.</p>
<p class="toc_element">
- <code><a href="#list">list(showDeleted=None, parent=None, view=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists every predefined Role that IAM supports, or every custom role</p>
+ <code><a href="#list">list(view=None, parent=None, pageSize=None, showDeleted=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#queryGrantableRoles">queryGrantableRoles(body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists roles that can be granted on a Google Cloud resource. A role is</p>
+<p class="firstline">Lists roles that can be granted on a Google Cloud resource. A role is grantable if the IAM policy for the resource can contain bindings to the role.</p>
<p class="toc_element">
<code><a href="#queryGrantableRoles_next">queryGrantableRoles_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets the definition of a Role.
Args:
- name: string, The `name` parameter's value depends on the target resource for the
-request, namely
-[`roles`](/iam/reference/rest/v1/roles),
-[`projects`](/iam/reference/rest/v1/projects.roles), or
-[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
-resource type's `name` value format is described below:
-
-* [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`.
- This method returns results from all
- [predefined roles](/iam/docs/understanding-roles#predefined_roles) in
- Cloud IAM. Example request URL:
- `https://iam.googleapis.com/v1/roles/{ROLE_NAME}`
-
-* [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get):
- `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only
- [custom roles](/iam/docs/understanding-custom-roles) that have been
- created at the project level. Example request URL:
- `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`
-
-* [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get):
- `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
- returns only [custom roles](/iam/docs/understanding-custom-roles) that
- have been created at the organization level. Example request URL:
- `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`
-
-Note: Wildcard (*) values are invalid; you must specify a complete project
-ID or organization ID. (required)
+ name: string, The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -131,70 +113,31 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "name": "A String", # The name of the role.
- #
- # When Role is used in CreateRole, the role name must not be set.
- #
- # When Role is used in output and other input such as UpdateRole, the role
- # name is the complete path, e.g., roles/logging.viewer for predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
- # selected for a role, the `stage` field will not be included in the
- # returned definition for the role.
- }</pre>
+ "description": "A String", # Optional. A human-readable description for the role.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
+ "name": "A String", # The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ "deleted": True or False, # The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(showDeleted=None, parent=None, view=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
- <pre>Lists every predefined Role that IAM supports, or every custom role
-that is defined for an organization or project.
+ <code class="details" id="list">list(view=None, parent=None, pageSize=None, showDeleted=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project.
Args:
+ view: string, Optional view for the returned Role objects. When `FULL` is specified, the `includedPermissions` field is returned, which includes a list of all permissions in the role. The default value is `BASIC`, which does not return the `includedPermissions` field.
+ Allowed values
+ BASIC - Omits the `included_permissions` field. This is the default value.
+ FULL - Returns all fields.
+ parent: string, The `parent` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` value format is described below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. This method doesn't require a resource; it simply returns all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.
+ pageSize: integer, Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 1,000.
showDeleted: boolean, Include Roles that have been deleted.
- parent: string, The `parent` parameter's value depends on the target resource for the
-request, namely
-[`roles`](/iam/reference/rest/v1/roles),
-[`projects`](/iam/reference/rest/v1/projects.roles), or
-[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
-resource type's `parent` value format is described below:
-
-* [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string.
- This method doesn't require a resource; it simply returns all
- [predefined roles](/iam/docs/understanding-roles#predefined_roles) in
- Cloud IAM. Example request URL:
- `https://iam.googleapis.com/v1/roles`
-
-* [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list):
- `projects/{PROJECT_ID}`. This method lists all project-level
- [custom roles](/iam/docs/understanding-custom-roles).
- Example request URL:
- `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
-
-* [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list):
- `organizations/{ORGANIZATION_ID}`. This method lists all
- organization-level [custom roles](/iam/docs/understanding-custom-roles).
- Example request URL:
- `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
-
-Note: Wildcard (*) values are invalid; you must specify a complete project
-ID or organization ID.
- view: string, Optional view for the returned Role objects. When `FULL` is specified,
-the `includedPermissions` field is returned, which includes a list of all
-permissions in the role. The default value is `BASIC`, which does not
-return the `includedPermissions` field.
pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
- pageSize: integer, Optional limit on the number of roles to include in the response.
-
-The default is 300, and the maximum is 1,000.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -204,30 +147,19 @@
An object of the form:
{ # The response containing the roles defined under a resource.
- "nextPageToken": "A String", # To retrieve the next page of results, set
- # `ListRolesRequest.page_token` to this value.
+ "nextPageToken": "A String", # To retrieve the next page of results, set `ListRolesRequest.page_token` to this value.
"roles": [ # The Roles defined on this resource.
{ # A role in the Identity and Access Management API.
- "name": "A String", # The name of the role.
- #
- # When Role is used in CreateRole, the role name must not be set.
- #
- # When Role is used in output and other input such as UpdateRole, the role
- # name is the complete path, e.g., roles/logging.viewer for predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
- # selected for a role, the `stage` field will not be included in the
- # returned definition for the role.
- },
+ "description": "A String", # Optional. A human-readable description for the role.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
+ "name": "A String", # The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ "deleted": True or False, # The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
+ },
],
}</pre>
</div>
@@ -248,26 +180,17 @@
<div class="method">
<code class="details" id="queryGrantableRoles">queryGrantableRoles(body=None, x__xgafv=None)</code>
- <pre>Lists roles that can be granted on a Google Cloud resource. A role is
-grantable if the IAM policy for the resource can contain bindings to the
-role.
+ <pre>Lists roles that can be granted on a Google Cloud resource. A role is grantable if the IAM policy for the resource can contain bindings to the role.
Args:
body: object, The request body.
The object takes the form of:
{ # The grantable role query request.
- "pageToken": "A String", # Optional pagination token returned in an earlier
- # QueryGrantableRolesResponse.
"view": "A String",
- "pageSize": 42, # Optional limit on the number of roles to include in the response.
- #
- # The default is 300, and the maximum is 1,000.
- "fullResourceName": "A String", # Required. The full resource name to query from the list of grantable roles.
- #
- # 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`.
+ "pageToken": "A String", # Optional pagination token returned in an earlier QueryGrantableRolesResponse.
+ "fullResourceName": "A String", # Required. The full resource name to query from the list of grantable roles. 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`.
+ "pageSize": 42, # Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 1,000.
}
x__xgafv: string, V1 error format.
@@ -281,29 +204,18 @@
{ # The grantable role query response.
"roles": [ # The list of matching roles.
{ # A role in the Identity and Access Management API.
- "name": "A String", # The name of the role.
- #
- # When Role is used in CreateRole, the role name must not be set.
- #
- # When Role is used in output and other input such as UpdateRole, the role
- # name is the complete path, e.g., roles/logging.viewer for predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
- # selected for a role, the `stage` field will not be included in the
- # returned definition for the role.
- },
+ "description": "A String", # Optional. A human-readable description for the role.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.
+ "name": "A String", # The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ "deleted": True or False, # The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
+ },
],
- "nextPageToken": "A String", # To retrieve the next page of results, set
- # `QueryGrantableRolesRequest.page_token` to this value.
+ "nextPageToken": "A String", # To retrieve the next page of results, set `QueryGrantableRolesRequest.page_token` to this value.
}</pre>
</div>