docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/firebaserules_v1.projects.rulesets.html b/docs/dyn/firebaserules_v1.projects.rulesets.html
index bbb13b8..617178e 100644
--- a/docs/dyn/firebaserules_v1.projects.rulesets.html
+++ b/docs/dyn/firebaserules_v1.projects.rulesets.html
@@ -75,106 +75,57 @@
<h1><a href="firebaserules_v1.html">Firebase Rules API</a> . <a href="firebaserules_v1.projects.html">projects</a> . <a href="firebaserules_v1.projects.rulesets.html">rulesets</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="#create">create(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Create a `Ruleset` from `Source`.</p>
+<p class="firstline">Create a `Ruleset` from `Source`. The `Ruleset` is given a unique generated name which is returned to the caller. `Source` containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of `Source` issues, use TestRuleset.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Delete a `Ruleset` by resource name.</p>
+<p class="firstline">Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a `Ruleset` by name including the full `Source` contents.</p>
<p class="toc_element">
- <code><a href="#list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
-<p class="firstline">List `Ruleset` metadata only and optionally filter the results by `Ruleset`</p>
+ <code><a href="#list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
+<p class="firstline">List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. The full `Source` contents of a `Ruleset` may be retrieved with GetRuleset.</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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
- <pre>Create a `Ruleset` from `Source`.
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
-The `Ruleset` is given a unique generated name which is returned to the
-caller. `Source` containing syntactic or semantics errors will result in an
-error response indicating the first error encountered. For a detailed view
-of `Source` issues, use TestRuleset.
+<div class="method">
+ <code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
+ <pre>Create a `Ruleset` from `Source`. The `Ruleset` is given a unique generated name which is returned to the caller. `Source` containing syntactic or semantics errors will result in an error response indicating the first error encountered. For a detailed view of `Source` issues, use TestRuleset.
Args:
- name: string, Resource name for Project which owns this `Ruleset`.
-
-Format: `projects/{project_id}` (required)
+ name: string, Resource name for Project which owns this `Ruleset`. Format: `projects/{project_id}` (required)
body: object, The request body.
The object takes the form of:
-{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
- # and a creation time.
- "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
- "files": [ # `File` set constituting the `Source` bundle.
- { # `File` containing source content.
- "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
- "name": "A String", # File name.
- "content": "A String", # Textual Content.
- },
- ],
- },
- "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
- # Format: `projects/{project_id}/rulesets/{ruleset_id}`
- # Output only.
- "createTime": "A String", # Time the `Ruleset` was created.
- # Output only.
- "metadata": { # Metadata for a Ruleset. # The metadata for this ruleset.
- # Output only.
- "services": [ # Services that this ruleset has declarations for (e.g.,
- # "cloud.firestore"). There may be 0+ of these.
- "A String",
- ],
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
- # and a creation time.
+{ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
+ "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` Output only.
+ "createTime": "A String", # Time the `Ruleset` was created. Output only.
+ "metadata": { # Metadata for a Ruleset. # The metadata for this ruleset. Output only.
+ "services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
+ "A String",
+ ],
+ },
"source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
"files": [ # `File` set constituting the `Source` bundle.
{ # `File` containing source content.
"fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
- "name": "A String", # File name.
"content": "A String", # Textual Content.
+ "name": "A String", # File name.
},
],
},
- "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
- # Format: `projects/{project_id}/rulesets/{ruleset_id}`
- # Output only.
- "createTime": "A String", # Time the `Ruleset` was created.
- # Output only.
- "metadata": { # Metadata for a Ruleset. # The metadata for this ruleset.
- # Output only.
- "services": [ # Services that this ruleset has declarations for (e.g.,
- # "cloud.firestore"). There may be 0+ of these.
- "A String",
- ],
- },
- }</pre>
-</div>
+ }
-<div class="method">
- <code class="details" id="delete">delete(name, x__xgafv=None)</code>
- <pre>Delete a `Ruleset` by resource name.
-
-If the `Ruleset` is referenced by a `Release` the operation will fail.
-
-Args:
- name: string, Resource name for the ruleset to delete.
-
-Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -183,15 +134,41 @@
Returns:
An object of the form:
- { # A generic empty message that you can re-use to avoid defining duplicated
- # empty messages in your APIs. A typical example is to use it as the request
- # or the response type of an API method. For instance:
- #
- # service Foo {
- # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
- # }
- #
- # The JSON representation for `Empty` is empty JSON object `{}`.
+ { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
+ "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` Output only.
+ "createTime": "A String", # Time the `Ruleset` was created. Output only.
+ "metadata": { # Metadata for a Ruleset. # The metadata for this ruleset. Output only.
+ "services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
+ "A String",
+ ],
+ },
+ "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
+ "files": [ # `File` set constituting the `Source` bundle.
+ { # `File` containing source content.
+ "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
+ "content": "A String", # Textual Content.
+ "name": "A String", # File name.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a `Release` the operation will fail.
+
+Args:
+ name: string, Resource name for the ruleset to delete. Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
@@ -200,9 +177,7 @@
<pre>Get a `Ruleset` by name including the full `Source` contents.
Args:
- name: string, Resource name for the ruleset to get.
-
-Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
+ name: string, Resource name for the ruleset to get. Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -211,56 +186,35 @@
Returns:
An object of the form:
- { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
- # and a creation time.
- "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
- "files": [ # `File` set constituting the `Source` bundle.
- { # `File` containing source content.
- "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
- "name": "A String", # File name.
- "content": "A String", # Textual Content.
- },
- ],
- },
- "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
- # Format: `projects/{project_id}/rulesets/{ruleset_id}`
- # Output only.
- "createTime": "A String", # Time the `Ruleset` was created.
- # Output only.
- "metadata": { # Metadata for a Ruleset. # The metadata for this ruleset.
- # Output only.
- "services": [ # Services that this ruleset has declarations for (e.g.,
- # "cloud.firestore"). There may be 0+ of these.
- "A String",
- ],
- },
- }</pre>
+ { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
+ "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` Output only.
+ "createTime": "A String", # Time the `Ruleset` was created. Output only.
+ "metadata": { # Metadata for a Ruleset. # The metadata for this ruleset. Output only.
+ "services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
+ "A String",
+ ],
+ },
+ "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
+ "files": [ # `File` set constituting the `Source` bundle.
+ { # `File` containing source content.
+ "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
+ "content": "A String", # Textual Content.
+ "name": "A String", # File name.
+ },
+ ],
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
- <pre>List `Ruleset` metadata only and optionally filter the results by `Ruleset`
-name.
-
-The full `Source` contents of a `Ruleset` may be retrieved with
-GetRuleset.
+ <code class="details" id="list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
+ <pre>List `Ruleset` metadata only and optionally filter the results by `Ruleset` name. The full `Source` contents of a `Ruleset` may be retrieved with GetRuleset.
Args:
- name: string, Resource name for the project.
-
-Format: `projects/{project_id}` (required)
- filter: string, `Ruleset` filter. The list method supports filters with restrictions on
-`Ruleset.name`.
-
-Filters on `Ruleset.create_time` should use the `date` function which
-parses strings that conform to the RFC 3339 date/time specifications.
-
-Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*`
+ name: string, Resource name for the project. Format: `projects/{project_id}` (required)
pageToken: string, Next page token for loading the next batch of `Ruleset` instances.
- pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
-Note: `page_size` is just a hint and the service may choose to load less
-than `page_size` due to the size of the output. To traverse all of the
-releases, caller should iterate until the `page_token` is empty.
+ pageSize: integer, Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a hint and the service may choose to load less than `page_size` due to the size of the output. To traverse all of the releases, caller should iterate until the `page_token` is empty.
+ filter: string, `Ruleset` filter. The list method supports filters with restrictions on `Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function which parses strings that conform to the RFC 3339 date/time specifications. Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -271,33 +225,26 @@
{ # The response for FirebaseRulesService.ListRulesets.
"rulesets": [ # List of `Ruleset` instances.
- { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
- # and a creation time.
- "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
- "files": [ # `File` set constituting the `Source` bundle.
- { # `File` containing source content.
- "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
- "name": "A String", # File name.
- "content": "A String", # Textual Content.
- },
- ],
+ { # `Ruleset` is an immutable copy of `Source` with a globally unique identifier and a creation time.
+ "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: `projects/{project_id}/rulesets/{ruleset_id}` Output only.
+ "createTime": "A String", # Time the `Ruleset` was created. Output only.
+ "metadata": { # Metadata for a Ruleset. # The metadata for this ruleset. Output only.
+ "services": [ # Services that this ruleset has declarations for (e.g., "cloud.firestore"). There may be 0+ of these.
+ "A String",
+ ],
+ },
+ "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` for the `Ruleset`.
+ "files": [ # `File` set constituting the `Source` bundle.
+ { # `File` containing source content.
+ "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
+ "content": "A String", # Textual Content.
+ "name": "A String", # File name.
+ },
+ ],
+ },
},
- "name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
- # Format: `projects/{project_id}/rulesets/{ruleset_id}`
- # Output only.
- "createTime": "A String", # Time the `Ruleset` was created.
- # Output only.
- "metadata": { # Metadata for a Ruleset. # The metadata for this ruleset.
- # Output only.
- "services": [ # Services that this ruleset has declarations for (e.g.,
- # "cloud.firestore"). There may be 0+ of these.
- "A String",
- ],
- },
- },
],
- "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
- # empty, no further results remain.
+ "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
}</pre>
</div>