docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/firebaserules_v1.projects.rulesets.html b/docs/dyn/firebaserules_v1.projects.rulesets.html
index 12eee95..40ff507 100644
--- a/docs/dyn/firebaserules_v1.projects.rulesets.html
+++ b/docs/dyn/firebaserules_v1.projects.rulesets.html
@@ -84,7 +84,7 @@
<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, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
+ <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>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -107,29 +107,29 @@
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.
- "content": "A String", # Textual Content.
- "name": "A String", # File name.
- "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
- },
- ],
- },
- "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",
- ],
- },
- }
+ # and a creation time.
+ "createTime": "A String", # Time the `Ruleset` was created.
+ # Output only.
+ "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.
+ "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.
+ "content": "A String", # Textual Content.
+ "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
+ "name": "A String", # File name.
+ },
+ ],
+ },
+ "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
@@ -140,29 +140,29 @@
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.
- "content": "A String", # Textual Content.
- "name": "A String", # File name.
- "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
- },
- ],
- },
- "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>
+ # and a creation time.
+ "createTime": "A String", # Time the `Ruleset` was created.
+ # Output only.
+ "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.
+ "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.
+ "content": "A String", # Textual Content.
+ "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
+ "name": "A String", # File name.
+ },
+ ],
+ },
+ "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">
@@ -212,33 +212,33 @@
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.
- "content": "A String", # Textual Content.
- "name": "A String", # File name.
- "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
- },
- ],
- },
- "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>
+ # and a creation time.
+ "createTime": "A String", # Time the `Ruleset` was created.
+ # Output only.
+ "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.
+ "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.
+ "content": "A String", # Textual Content.
+ "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
+ "name": "A String", # File name.
+ },
+ ],
+ },
+ "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="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
+ <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.
@@ -249,55 +249,55 @@
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.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
- 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-*`
+Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*`
+ 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.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # The response for FirebaseRulesService.ListRulesets.
- "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
- # empty, no further results remain.
- "rulesets": [ # List of `Ruleset` instances.
+ "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.
- "content": "A String", # Textual Content.
- "name": "A String", # File name.
- "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
- },
- ],
- },
- "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",
- ],
- },
+ # and a creation time.
+ "createTime": "A String", # Time the `Ruleset` was created.
+ # Output only.
+ "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.
+ "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.
+ "content": "A String", # Textual Content.
+ "fingerprint": "A String", # Fingerprint (e.g. github sha) associated with the `File`.
+ "name": "A String", # File name.
+ },
+ ],
},
+ "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.
}</pre>
</div>
@@ -310,7 +310,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>