docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/firebase_v1beta1.projects.iosApps.html b/docs/dyn/firebase_v1beta1.projects.iosApps.html
index 9c65e18..3a67f61 100644
--- a/docs/dyn/firebase_v1beta1.projects.iosApps.html
+++ b/docs/dyn/firebase_v1beta1.projects.iosApps.html
@@ -75,52 +75,49 @@
<h1><a href="firebase_v1beta1.html">Firebase Management API</a> . <a href="firebase_v1beta1.projects.html">projects</a> . <a href="firebase_v1beta1.projects.iosApps.html">iosApps</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(parent, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Requests that a new IosApp be created.</p>
+<p class="firstline">Requests the creation of a new IosApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the IosApp identified by the specified resource name.</p>
+<p class="firstline">Gets the specified IosApp.</p>
<p class="toc_element">
<code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the configuration artifact associated with the specified IosApp.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists each IosApp associated with the specified parent Project.</p>
+<p class="firstline">Lists each IosApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`.</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="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates the attributes of the IosApp identified by the specified</p>
+<p class="firstline">Updates the attributes of the specified IosApp.</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="create">create(parent, body=None, x__xgafv=None)</code>
- <pre>Requests that a new IosApp be created.
-<br>
-<br>The result of this call is an `Operation` which can be used to track
-the provisioning process. The `Operation` is automatically deleted after
-completion, so there is no need to call `DeleteOperation`.
+ <pre>Requests the creation of a new IosApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.
Args:
- parent: string, The parent Project in which to create an App, in the format:
-<br><code>projects/<var>PROJECT_NUMBER</var></code> (required)
+ parent: string, The resource name of the parent FirebaseProject in which to create an IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
body: object, The request body.
The object takes the form of:
{ # Details of a Firebase App for iOS.
- "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.
- # <br>
- # <br>This identifier should be treated as an opaque token, as the data
- # format is not specified.
- "displayName": "A String", # The user-assigned display name of the App.
- "bundleId": "A String", # The canonical bundle ID of the iOS App as it would appear in the iOS
- # AppStore.
- "name": "A String", # The fully qualified resource name of the App, in the format:
- # <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
- "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App.
- "appStoreId": "A String", # The automatically generated Apple ID assigned to the App by Apple in the
- # iOS App Store.
-}
+ "appStoreId": "A String", # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
+ "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
+ "displayName": "A String", # The user-assigned display name for the `IosApp`.
+ "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not specified.
+ "name": "A String", # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
+ "bundleId": "A String", # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -130,61 +127,33 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Gets the IosApp identified by the specified resource name.
+ <pre>Gets the specified IosApp.
Args:
- name: string, The fully qualified resource name of the App, in the format:
-<code>projects/<var>PROJECT_NUMBER</var>/iosApps/<var>APP_ID</var></code>
-<br>As an <var>APP_ID</var> is a unique identifier, the Unique Resource
-from Sub-Collection access pattern may be used here, in the format:
-<br><code>projects/-/iosApps/<var>APP_ID</var></code> (required)
+ name: string, The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the `IosApp` [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -194,19 +163,13 @@
An object of the form:
{ # Details of a Firebase App for iOS.
- "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.
- # <br>
- # <br>This identifier should be treated as an opaque token, as the data
- # format is not specified.
- "displayName": "A String", # The user-assigned display name of the App.
- "bundleId": "A String", # The canonical bundle ID of the iOS App as it would appear in the iOS
- # AppStore.
- "name": "A String", # The fully qualified resource name of the App, in the format:
- # <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
- "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App.
- "appStoreId": "A String", # The automatically generated Apple ID assigned to the App by Apple in the
- # iOS App Store.
- }</pre>
+ "appStoreId": "A String", # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
+ "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
+ "displayName": "A String", # The user-assigned display name for the `IosApp`.
+ "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not specified.
+ "name": "A String", # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
+ "bundleId": "A String", # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
+ }</pre>
</div>
<div class="method">
@@ -214,11 +177,7 @@
<pre>Gets the configuration artifact associated with the specified IosApp.
Args:
- name: string, The resource name of the App configuration to download, in the format:
-<br><code>projects/<var>PROJECT_NUMBER</var>/iosApps/<var>APP_ID</var>/config</code>
-<br>As an <var>APP_ID</var> is a unique identifier, the Unique Resource
-from Sub-Collection access pattern may be used here, in the format:
-<br><code>projects/-/iosApps/<var>APP_ID</var></code> (required)
+ name: string, The resource name of the App configuration to download, in the format: projects/PROJECT_IDENTIFIER/iosApps/APP_ID/config Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the `IosApp` [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -228,30 +187,19 @@
An object of the form:
{ # Configuration metadata of a single Firebase App for iOS.
+ "configFilename": "A String", # The filename that the configuration artifact for the `IosApp` is typically saved as. For example: `GoogleService-Info.plist`
"configFileContents": "A String", # The content of the XML configuration file.
- "configFilename": "A String", # The filename that the configuration artifact is typically saved as.
- # <br>For example: `GoogleService-Info.plist`
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
- <pre>Lists each IosApp associated with the specified parent Project.
-<br>
-<br>The elements are returned in no particular order, but will be a
-consistent view of the Apps when additional requests are made with a
-`pageToken`.
+ <pre>Lists each IosApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`.
Args:
- parent: string, The parent Project for which to list Apps, in the format:
-<br><code>projects/<var>PROJECT_NUMBER</var></code> (required)
- pageToken: string, Token returned from a previous call to `ListIosApps` indicating where in
-the set of Apps to resume listing.
- pageSize: integer, The maximum number of Apps to return in the response.
-<br>
-<br>The server may return fewer than this at its discretion.
-If no value is specified (or too large a value is specified), the server
-will impose its own limit.
+ parent: string, The resource name of the parent FirebaseProject for which to list each associated IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
+ pageToken: string, Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing.
+ pageSize: integer, The maximum number of Apps to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -261,30 +209,17 @@
An object of the form:
{
- "apps": [ # List of each IosApp that is in the parent Firebase Project.
+ "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent call to `ListIosApps` to find the next group of Apps. Page tokens are short-lived and should not be persisted.
+ "apps": [ # List of each `IosApp` associated with the specified `FirebaseProject`.
{ # Details of a Firebase App for iOS.
- "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.
- # <br>
- # <br>This identifier should be treated as an opaque token, as the data
- # format is not specified.
- "displayName": "A String", # The user-assigned display name of the App.
- "bundleId": "A String", # The canonical bundle ID of the iOS App as it would appear in the iOS
- # AppStore.
- "name": "A String", # The fully qualified resource name of the App, in the format:
- # <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
- "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App.
- "appStoreId": "A String", # The automatically generated Apple ID assigned to the App by Apple in the
- # iOS App Store.
- },
+ "appStoreId": "A String", # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
+ "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
+ "displayName": "A String", # The user-assigned display name for the `IosApp`.
+ "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not specified.
+ "name": "A String", # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
+ "bundleId": "A String", # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
+ },
],
- "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token
- # is returned. If the string is empty, then this response is the last page of
- # results.
- # <br>
- # <br>This token can be used in a subsequent call to `ListIosApps` to find
- # the next group of Apps.
- # <br>
- # <br>Page tokens are short-lived and should not be persisted.
}</pre>
</div>
@@ -304,33 +239,23 @@
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
- <pre>Updates the attributes of the IosApp identified by the specified
-resource name.
+ <pre>Updates the attributes of the specified IosApp.
Args:
- name: string, The fully qualified resource name of the App, in the format:
-<br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code> (required)
+ name: string, The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)). (required)
body: object, The request body.
The object takes the form of:
{ # Details of a Firebase App for iOS.
- "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.
- # <br>
- # <br>This identifier should be treated as an opaque token, as the data
- # format is not specified.
- "displayName": "A String", # The user-assigned display name of the App.
- "bundleId": "A String", # The canonical bundle ID of the iOS App as it would appear in the iOS
- # AppStore.
- "name": "A String", # The fully qualified resource name of the App, in the format:
- # <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
- "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App.
- "appStoreId": "A String", # The automatically generated Apple ID assigned to the App by Apple in the
- # iOS App Store.
-}
+ "appStoreId": "A String", # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
+ "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
+ "displayName": "A String", # The user-assigned display name for the `IosApp`.
+ "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not specified.
+ "name": "A String", # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
+ "bundleId": "A String", # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
+ }
- updateMask: string, Specifies which fields to update.
-<br>Note that the fields `name`, `appId`, `projectId`, and `bundleId`
-are all immutable.
+ updateMask: string, Specifies which fields to update. Note that the fields `name`, `appId`, `projectId`, and `bundleId` are all immutable.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -340,19 +265,13 @@
An object of the form:
{ # Details of a Firebase App for iOS.
- "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.
- # <br>
- # <br>This identifier should be treated as an opaque token, as the data
- # format is not specified.
- "displayName": "A String", # The user-assigned display name of the App.
- "bundleId": "A String", # The canonical bundle ID of the iOS App as it would appear in the iOS
- # AppStore.
- "name": "A String", # The fully qualified resource name of the App, in the format:
- # <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
- "projectId": "A String", # The globally unique, user-assigned ID of the parent Project for the App.
- "appStoreId": "A String", # The automatically generated Apple ID assigned to the App by Apple in the
- # iOS App Store.
- }</pre>
+ "appStoreId": "A String", # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
+ "projectId": "A String", # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
+ "displayName": "A String", # The user-assigned display name for the `IosApp`.
+ "appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not specified.
+ "name": "A String", # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
+ "bundleId": "A String", # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
+ }</pre>
</div>
</body></html>
\ No newline at end of file