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.releases.html b/docs/dyn/firebaserules_v1.projects.releases.html
index b71c6b3..5f2be17 100644
--- a/docs/dyn/firebaserules_v1.projects.releases.html
+++ b/docs/dyn/firebaserules_v1.projects.releases.html
@@ -87,7 +87,7 @@
<code><a href="#getExecutable">getExecutable(name, executableVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get the `Release` executable to use when enforcing rules.</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 the `Release` values for a project. This list may optionally be</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -100,13 +100,13 @@
<code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
<pre>Create a `Release`.
-Release names should reflect the developer's deployment practices. For
+Release names should reflect the developer's deployment practices. For
example, the release name may include the environment name, application
name, application version, or any other name meaningful to the developer.
Once a `Release` refers to a `Ruleset`, the rules can be enforced by
Firebase Rules-enabled services.
-More than one `Release` may be 'live' concurrently. Consider the following
+More than one `Release` may be 'live' concurrently. Consider the following
three `Release` names for `projects/foo` and the `Ruleset` to which they
refer.
@@ -130,11 +130,11 @@
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
- "updateTime": "A String", # Time the release was updated.
+ "createTime": "A String", # Time the release was created.
# Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
- # exist the `Release` to be created.
- "name": "A String", # Resource name for the `Release`.
+ "updateTime": "A String", # Time the release was updated.
+ # Output only.
+ "name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
@@ -158,8 +158,8 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
- "createTime": "A String", # Time the release was created.
- # Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
+ # exist the `Release` to be created.
}
x__xgafv: string, V1 error format.
@@ -172,11 +172,11 @@
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
- "updateTime": "A String", # Time the release was updated.
+ "createTime": "A String", # Time the release was created.
# Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
- # exist the `Release` to be created.
- "name": "A String", # Resource name for the `Release`.
+ "updateTime": "A String", # Time the release was updated.
+ # Output only.
+ "name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
@@ -200,8 +200,8 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
- "createTime": "A String", # Time the release was created.
- # Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
+ # exist the `Release` to be created.
}</pre>
</div>
@@ -251,11 +251,11 @@
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
- "updateTime": "A String", # Time the release was updated.
+ "createTime": "A String", # Time the release was created.
# Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
- # exist the `Release` to be created.
- "name": "A String", # Resource name for the `Release`.
+ "updateTime": "A String", # Time the release was updated.
+ # Output only.
+ "name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
@@ -279,8 +279,8 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
- "createTime": "A String", # Time the release was created.
- # Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
+ # exist the `Release` to be created.
}</pre>
</div>
@@ -303,19 +303,19 @@
An object of the form:
{ # The response for FirebaseRulesService.GetReleaseExecutable
- "updateTime": "A String", # Timestamp for the most recent `Release.update_time`.
- "language": "A String", # `Language` used to generate the executable bytes.
- "rulesetName": "A String", # `Ruleset` name associated with the `Release` executable.
- "executable": "A String", # Executable view of the `Ruleset` referenced by the `Release`.
- "syncTime": "A String", # Optional, indicates the freshness of the result. The response is
+ "syncTime": "A String", # Optional, indicates the freshness of the result. The response is
# guaranteed to be the latest within an interval up to the
# sync_time (inclusive).
- "executableVersion": "A String", # The Rules runtime version of the executable.
+ "executable": "A String", # Executable view of the `Ruleset` referenced by the `Release`.
+ "language": "A String", # `Language` used to generate the executable bytes.
+ "executableVersion": "A String", # The Rules runtime version of the executable.
+ "updateTime": "A String", # Timestamp for the most recent `Release.update_time`.
+ "rulesetName": "A String", # `Ruleset` name associated with the `Release` executable.
}</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 the `Release` values for a project. This list may optionally be
filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any
combination thereof.
@@ -324,21 +324,11 @@
name: string, Resource name for the project.
Format: `projects/{project_id}` (required)
- pageToken: string, Next page token for the next batch of `Release` 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 fewer
-than `page_size` results due to the size of the output. To traverse all of
-the releases, the caller should iterate until the `page_token` on the
-response is empty.
filter: string, `Release` filter. The list method supports filters with restrictions on the
`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.
-Example 1: A filter of 'name=prod*' might return `Release`s with names
-within 'projects/foo' prefixed with 'prod':
+Example 1: A filter of 'name=prod*' might return `Release`s with names
+within 'projects/foo' prefixed with 'prod':
Name | Ruleset Name
------------------------------|-------------
@@ -347,8 +337,8 @@
projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888
Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only
-`Release` instances for 'projects/foo' with names prefixed with 'prod'
-referring to the same `Ruleset` name of 'uuid1234':
+`Release` instances for 'projects/foo' with names prefixed with 'prod'
+referring to the same `Ruleset` name of 'uuid1234':
Name | Ruleset Name
------------------------------|-------------
@@ -358,21 +348,29 @@
In the examples, the filter parameters refer to the search filters are
relative to the project. Fully qualified prefixed may also be used. e.g.
`test_suite_name=projects/foo/testsuites/uuid1`
+ pageToken: string, Next page token for the next batch of `Release` 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 fewer
+than `page_size` results due to the size of the output. To traverse all of
+the releases, the caller should iterate until the `page_token` on the
+response 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.ListReleases.
- "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
- # empty, no further results remain.
- "releases": [ # List of `Release` instances.
+ "releases": [ # List of `Release` instances.
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
- "updateTime": "A String", # Time the release was updated.
+ "createTime": "A String", # Time the release was created.
# Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
- # exist the `Release` to be created.
- "name": "A String", # Resource name for the `Release`.
+ "updateTime": "A String", # Time the release was updated.
+ # Output only.
+ "name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
@@ -396,10 +394,12 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
- "createTime": "A String", # Time the release was created.
- # Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
+ # exist the `Release` to be created.
},
],
+ "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
+ # empty, no further results remain.
}</pre>
</div>
@@ -412,7 +412,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>
@@ -433,13 +433,14 @@
The object takes the form of:
{ # The request for FirebaseRulesService.UpdateReleasePatch.
- "release": { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a # `Release` to update.
+ "updateMask": "A String", # Specifies which fields to update.
+ "release": { # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a # `Release` to update.
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
- "updateTime": "A String", # Time the release was updated.
+ "createTime": "A String", # Time the release was created.
# Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
- # exist the `Release` to be created.
- "name": "A String", # Resource name for the `Release`.
+ "updateTime": "A String", # Time the release was updated.
+ # Output only.
+ "name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
@@ -463,10 +464,9 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
- "createTime": "A String", # Time the release was created.
- # Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
+ # exist the `Release` to be created.
},
- "updateMask": "A String", # Specifies which fields to update.
}
x__xgafv: string, V1 error format.
@@ -479,11 +479,11 @@
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
- "updateTime": "A String", # Time the release was updated.
+ "createTime": "A String", # Time the release was created.
# Output only.
- "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
- # exist the `Release` to be created.
- "name": "A String", # Resource name for the `Release`.
+ "updateTime": "A String", # Time the release was updated.
+ # Output only.
+ "name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
# which affords developers a great deal of flexibility in mapping the name
@@ -507,8 +507,8 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
- "createTime": "A String", # Time the release was created.
- # Output only.
+ "rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
+ # exist the `Release` to be created.
}</pre>
</div>