update dependencies

This commit is contained in:
Sebastian Thiel
2023-01-25 11:39:00 +01:00
parent 37ccd2238d
commit 3edefb7f01
357 changed files with 128026 additions and 16259 deletions

View File

@@ -341,6 +341,11 @@
"description": "Token returned from a previous call to `ListFirebaseProjects` indicating where in the set of Projects to resume listing.",
"location": "query",
"type": "string"
},
"showDeleted": {
"description": "Optional. Controls whether Projects in the DELETED state should be returned in the response. If not specified, only `ACTIVE` Projects will be returned.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta1/projects",
@@ -371,7 +376,7 @@
"type": "string"
},
"updateMask": {
"description": "Specifies which fields to update. If this list is empty, then no state will be updated. Note that the fields `name`, `projectId`, and `projectNumber` are all immutable.",
"description": "Specifies which fields of the FirebaseProject to update. Note that the following fields are immutable: `name`, `project_id`, and `project_number`. To update `state`, use any of the following Google Cloud endpoints: [`projects.delete`](https://cloud.google.com/resource-manager/reference/rest/v1/projects/delete) or [`projects.undelete`](https://cloud.google.com/resource-manager/reference/rest/v1/projects/undelete)",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -428,7 +433,7 @@
],
"parameters": {
"filter": {
"description": "A query string compatible with Google's [AIP-160](https://google.aip.dev/160) standard. Use any of the following fields in a query: * [`app_id`](../projects.apps#FirebaseAppInfo.FIELDS.app_id) * [`namespace`](../projects.apps#FirebaseAppInfo.FIELDS.namespace) * [`platform`](../projects.apps#FirebaseAppInfo.FIELDS.platform) We also support the following \"virtual\" fields (fields which are not actually part of the returned resource object, but can be queried as if they are pre-populated with specific values): * `sha1_hash`: This field is considered to be a repeated `string` field, populated with the list of all SHA-1 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * `sha256_hash`: This field is considered to be a repeated `string` field, populated with the list of all SHA-256 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * `app_store_id`: This field is considered to be a singular `string` field, populated with the Apple App Store ID registered with the app. This field is empty if the app is not an iOS app. * `team_id`: This field is considered to be a singular `string` field, populated with the Apple team ID registered with the app. This field is empty if the app is not an iOS app.",
"description": "A query string compatible with Google's [AIP-160 standard](https://google.aip.dev/160). Use any of the following fields in a query: * [`app_id`](../projects/searchApps#FirebaseAppInfo.FIELDS.app_id) * [`namespace`](../projects/searchApps#FirebaseAppInfo.FIELDS.namespace) * [`platform`](../projects/searchApps#FirebaseAppInfo.FIELDS.platform) This query also supports the following \"virtual\" fields. These are fields which are not actually part of the returned resource object, but they can be queried as if they are pre-populated with specific values. * `sha1_hash` or `sha1_hashes`: This field is considered to be a _repeated_ `string` field, populated with the list of all SHA-1 certificate fingerprints registered with the AndroidApp. This list is empty if the App is not an `AndroidApp`. * `sha256_hash` or `sha256_hashes`: This field is considered to be a _repeated_ `string` field, populated with the list of all SHA-256 certificate fingerprints registered with the AndroidApp. This list is empty if the App is not an `AndroidApp`. * `app_store_id`: This field is considered to be a _singular_ `string` field, populated with the Apple App Store ID registered with the IosApp. This field is empty if the App is not an `IosApp`. * `team_id`: This field is considered to be a _singular_ `string` field, populated with the Apple team ID registered with the IosApp. This field is empty if the App is not an `IosApp`.",
"location": "query",
"type": "string"
},
@@ -449,6 +454,11 @@
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"showDeleted": {
"description": "Controls whether Apps in the DELETED state should be returned. If not specified, only `ACTIVE` Apps will be returned.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta1/{+parent}:searchApps",
@@ -577,6 +587,11 @@
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"showDeleted": {
"description": "Controls whether Apps in the DELETED state should be returned in the response. If not specified, only `ACTIVE` Apps will be returned.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta1/{+parent}/androidApps",
@@ -607,7 +622,7 @@
"type": "string"
},
"updateMask": {
"description": "Specifies which fields to update. Note that the fields `name`, `app_id`, `project_id`, and `package_name` are all immutable.",
"description": "Specifies which fields of the AndroidApp to update. Note that the following fields are immutable: `name`, `app_id`, `project_id`, and `package_name`. To update `state`, use any of the following endpoints: RemoveAndroidApp or UndeleteAndroidApp.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -624,6 +639,64 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"remove": {
"description": "Removes the specified AndroidApp from the FirebaseProject.",
"flatPath": "v1beta1/projects/{projectsId}/androidApps/{androidAppsId}:remove",
"httpMethod": "POST",
"id": "firebase.projects.androidApps.remove",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/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/-/androidApps/APP_ID Refer to the AndroidApp [name](../projects.androidApps#AndroidApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values.",
"location": "path",
"pattern": "^projects/[^/]+/androidApps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:remove",
"request": {
"$ref": "RemoveAndroidAppRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"undelete": {
"description": "Restores the specified AndroidApp to the FirebaseProject.",
"flatPath": "v1beta1/projects/{projectsId}/androidApps/{androidAppsId}:undelete",
"httpMethod": "POST",
"id": "firebase.projects.androidApps.undelete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/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/-/androidApps/APP_ID Refer to the AndroidApp [name](../projects.androidApps#AndroidApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values.",
"location": "path",
"pattern": "^projects/[^/]+/androidApps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:undelete",
"request": {
"$ref": "UndeleteAndroidAppRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
},
"resources": {
@@ -905,6 +978,11 @@
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"showDeleted": {
"description": "Controls whether Apps in the DELETED state should be returned in the response. If not specified, only `ACTIVE` Apps will be returned.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta1/{+parent}/iosApps",
@@ -935,7 +1013,7 @@
"type": "string"
},
"updateMask": {
"description": "Specifies which fields to update. Note that the fields `name`, `appId`, `projectId`, and `bundleId` are all immutable.",
"description": "Specifies which fields of the IosApp to update. Note that the following fields are immutable: `name`, `app_id`, `project_id`, and `bundle_id`. To update `state`, use any of the following endpoints: RemoveIosApp or UndeleteIosApp.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -952,6 +1030,64 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"remove": {
"description": "Removes the specified IosApp from the FirebaseProject.",
"flatPath": "v1beta1/projects/{projectsId}/iosApps/{iosAppsId}:remove",
"httpMethod": "POST",
"id": "firebase.projects.iosApps.remove",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. 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.",
"location": "path",
"pattern": "^projects/[^/]+/iosApps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:remove",
"request": {
"$ref": "RemoveIosAppRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"undelete": {
"description": "Restores the specified IosApp to the FirebaseProject.",
"flatPath": "v1beta1/projects/{projectsId}/iosApps/{iosAppsId}:undelete",
"httpMethod": "POST",
"id": "firebase.projects.iosApps.undelete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. 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.",
"location": "path",
"pattern": "^projects/[^/]+/iosApps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:undelete",
"request": {
"$ref": "UndeleteIosAppRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
}
},
@@ -1068,6 +1204,11 @@
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"showDeleted": {
"description": "Controls whether Apps in the DELETED state should be returned in the response. If not specified, only `ACTIVE` Apps will be returned.",
"location": "query",
"type": "boolean"
}
},
"path": "v1beta1/{+parent}/webApps",
@@ -1098,7 +1239,7 @@
"type": "string"
},
"updateMask": {
"description": "Specifies which fields to update. Note that the fields `name`, `appId`, and `projectId` are all immutable.",
"description": "Specifies which fields of the WebApp to update. Note that the following fields are immutable: `name`, `app_id`, and `project_id`. To update `state`, use any of the following endpoints: RemoveWebApp or UndeleteWebApp.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -1115,13 +1256,71 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"remove": {
"description": "Removes the specified WebApp from the FirebaseProject.",
"flatPath": "v1beta1/projects/{projectsId}/webApps/{webAppsId}:remove",
"httpMethod": "POST",
"id": "firebase.projects.webApps.remove",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the WebApp, in the format: projects/ PROJECT_IDENTIFIER/webApps/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/-/webApps/APP_ID Refer to the WebApp [name](../projects.webApps#WebApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values.",
"location": "path",
"pattern": "^projects/[^/]+/webApps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:remove",
"request": {
"$ref": "RemoveWebAppRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"undelete": {
"description": "Restores the specified WebApp to the FirebaseProject.",
"flatPath": "v1beta1/projects/{projectsId}/webApps/{webAppsId}:undelete",
"httpMethod": "POST",
"id": "firebase.projects.webApps.undelete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the WebApp, in the format: projects/ PROJECT_IDENTIFIER/webApps/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/-/webApps/APP_ID Refer to the WebApp [name](../projects.webApps#WebApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values.",
"location": "path",
"pattern": "^projects/[^/]+/webApps/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}:undelete",
"request": {
"$ref": "UndeleteWebAppRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
}
}
}
}
},
"revision": "20220304",
"revision": "20230123",
"rootUrl": "https://firebase.googleapis.com/",
"schemas": {
"AddFirebaseRequest": {
@@ -1213,17 +1412,22 @@
"id": "AndroidApp",
"properties": {
"apiKeyId": {
"description": "The key_id of the GCP ApiKey associated with this App. If set must have no restrictions, or only have restrictions that are valid for the associated Firebase App. Cannot be set in create requests, instead an existing valid API Key will be chosen, or if no valid API Keys exist, one will be provisioned for you. Cannot be set to an empty value in update requests.",
"description": "The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `AndroidApp`. Be aware that this value is the UID of the API key, _not_ the [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App's [configuration artifact](../../rest/v1beta1/projects.androidApps/getConfig). If `api_key_id` is not set in requests to [`androidApps.Create`](../../rest/v1beta1/projects.androidApps/create), then Firebase automatically associates an `api_key_id` with the `AndroidApp`. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, `api_key_id` cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated `AndroidApp`. We recommend using the [Google Cloud Console](https://console.cloud.google.com/apis/credentials) to manage API keys.",
"type": "string"
},
"appId": {
"description": "Immutable. The globally unique, Firebase-assigned identifier for the `AndroidApp`. This identifier should be treated as an opaque token, as the data format is not specified.",
"description": "Output only. Immutable. The globally unique, Firebase-assigned identifier for the `AndroidApp`. This identifier should be treated as an opaque token, as the data format is not specified.",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "The user-assigned display name for the `AndroidApp`.",
"type": "string"
},
"etag": {
"description": "This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about `etag` in Google's [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.",
"type": "string"
},
"name": {
"description": "The resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/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.androidApps#AndroidApp.FIELDS.app_id)).",
"type": "string"
@@ -1233,7 +1437,37 @@
"type": "string"
},
"projectId": {
"description": "Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `AndroidApp`.",
"description": "Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `AndroidApp`.",
"readOnly": true,
"type": "string"
},
"sha1Hashes": {
"description": "The SHA1 certificate hashes for the AndroidApp.",
"items": {
"type": "string"
},
"type": "array"
},
"sha256Hashes": {
"description": "The SHA256 certificate hashes for the AndroidApp.",
"items": {
"type": "string"
},
"type": "array"
},
"state": {
"description": "Output only. The lifecycle state of the App.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"DELETED"
],
"enumDescriptions": [
"Unspecified state.",
"The App is active.",
"The App has been soft-deleted. After an App has been in the `DELETED` state for more than 30 days, it is considered expired and will be permanently deleted. Up until this time, you can restore the App by calling `Undelete` ([Android](projects.androidApps/undelete) | [iOS](projects.iosApps/undelete) | [web](projects.webApps/undelete))."
],
"readOnly": true,
"type": "string"
}
},
@@ -1260,26 +1494,30 @@
"id": "DefaultResources",
"properties": {
"hostingSite": {
"description": "The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: `myproject123-a5c16`",
"description": "Output only. The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: `myproject123-a5c16`",
"readOnly": true,
"type": "string"
},
"locationId": {
"description": "The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.",
"description": "Output only. The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.",
"readOnly": true,
"type": "string"
},
"realtimeDatabaseInstance": {
"description": "The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: `myproject123-a5c16`",
"description": "Output only. The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: `myproject123-a5c16`",
"readOnly": true,
"type": "string"
},
"storageBucket": {
"description": "The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com",
"description": "Output only. The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "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 `{}`.",
"description": "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); }",
"id": "Empty",
"properties": {},
"type": "object"
@@ -1298,6 +1536,10 @@
"description": "A high-level summary of an App.",
"id": "FirebaseAppInfo",
"properties": {
"apiKeyId": {
"description": "The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the App. Be aware that this value is the UID of the API key, _not_ the [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App's configuration artifact ([`AndroidApp`](../../rest/v1beta1/projects.androidApps/getConfig) | [`IosApp`](../../rest/v1beta1/projects.iosApps/getConfig) | [`WebApp`](../../rest/v1beta1/projects.webApps/getConfig)). If `api_key_id` is not set in requests to create the App ([`AndroidApp`](../../rest/v1beta1/projects.androidApps/create) | [`IosApp`](../../rest/v1beta1/projects.iosApps/create) | [`WebApp`](../../rest/v1beta1/projects.webApps/create)), then Firebase automatically associates an `api_key_id` with the App. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned.",
"type": "string"
},
"appId": {
"description": "Output only. Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. This identifier should be treated as an opaque token, as the data format is not specified.",
"readOnly": true,
@@ -1331,6 +1573,21 @@
"The Firebase App is associated with web."
],
"type": "string"
},
"state": {
"description": "Output only. The lifecycle state of the App.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"DELETED"
],
"enumDescriptions": [
"Unspecified state.",
"The App is active.",
"The App has been soft-deleted. After an App has been in the `DELETED` state for more than 30 days, it is considered expired and will be permanently deleted. Up until this time, you can restore the App by calling `Undelete` ([Android](projects.androidApps/undelete) | [iOS](projects.iosApps/undelete) | [web](projects.webApps/undelete))."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
@@ -1339,29 +1596,43 @@
"description": "A `FirebaseProject` is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and Google Cloud Platform (GCP) resources. You create a `FirebaseProject` by calling AddFirebase and specifying an *existing* [GCP `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects). This adds Firebase resources to the existing GCP `Project`. Since a FirebaseProject is actually also a GCP `Project`, a `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and `projectId`). This allows for easy interop with Google APIs.",
"id": "FirebaseProject",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "A set of user-defined annotations for the FirebaseProject. Learn more about annotations in Google's [AIP-128 standard](https://google.aip.dev/128#annotations). These annotations are intended solely for developers and client-side tools. Firebase services will not mutate this annotations set.",
"type": "object"
},
"displayName": {
"description": "The user-assigned display name of the Project.",
"type": "string"
},
"etag": {
"description": "This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about `etag` in Google's [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.",
"type": "string"
},
"name": {
"description": "The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the 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`.",
"type": "string"
},
"projectId": {
"description": "Immutable. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.",
"description": "Output only. Immutable. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.",
"readOnly": true,
"type": "string"
},
"projectNumber": {
"description": "Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or third-party services.",
"description": "Output only. Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or third-party services.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"resources": {
"$ref": "DefaultResources",
"description": "The default Firebase resources associated with the Project."
"description": "Output only. The default Firebase resources associated with the Project.",
"readOnly": true
},
"state": {
"description": "Output only. The lifecycle state of the Project. Updates to the state must be performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject and com.google.cloudresourcemanager.v1.Projects.UndeleteProject",
"description": "Output only. The lifecycle state of the Project.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
@@ -1369,8 +1640,8 @@
],
"enumDescriptions": [
"Unspecified state.",
"The normal and active state.",
"The Project has been marked for deletion by the user."
"The Project is active.",
"The Project has been soft-deleted."
],
"readOnly": true,
"type": "string"
@@ -1383,11 +1654,12 @@
"id": "IosApp",
"properties": {
"apiKeyId": {
"description": "The key_id of the GCP ApiKey associated with this App. If set must have no restrictions, or only have restrictions that are valid for the associated Firebase App. Cannot be set in create requests, instead an existing valid API Key will be chosen, or if no valid API Keys exist, one will be provisioned for you. Cannot be set to an empty value in update requests.",
"description": "The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `IosApp`. Be aware that this value is the UID of the API key, _not_ the [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App's [configuration artifact](../../rest/v1beta1/projects.iosApps/getConfig). If `api_key_id` is not set in requests to [`iosApps.Create`](../../rest/v1beta1/projects.iosApps/create), then Firebase automatically associates an `api_key_id` with the `IosApp`. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, `api_key_id` cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated `IosApp`. We recommend using the [Google Cloud Console](https://console.cloud.google.com/apis/credentials) to manage API keys.",
"type": "string"
},
"appId": {
"description": "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.",
"description": "Output only. 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.",
"readOnly": true,
"type": "string"
},
"appStoreId": {
@@ -1402,12 +1674,32 @@
"description": "The user-assigned display name for the `IosApp`.",
"type": "string"
},
"etag": {
"description": "This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about `etag` in Google's [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.",
"type": "string"
},
"name": {
"description": "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)).",
"type": "string"
},
"projectId": {
"description": "Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.",
"description": "Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The lifecycle state of the App.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"DELETED"
],
"enumDescriptions": [
"Unspecified state.",
"The App is active.",
"The App has been soft-deleted. After an App has been in the `DELETED` state for more than 30 days, it is considered expired and will be permanently deleted. Up until this time, you can restore the App by calling `Undelete` ([Android](projects.androidApps/undelete) | [iOS](projects.iosApps/undelete) | [web](projects.webApps/undelete))."
],
"readOnly": true,
"type": "string"
},
"teamId": {
@@ -1633,6 +1925,20 @@
},
"type": "object"
},
"ProductMetadata": {
"description": "Metadata about a long-running Product operation.",
"id": "ProductMetadata",
"properties": {
"warningMessages": {
"description": "List of warnings related to the associated operation.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ProjectInfo": {
"description": "A reference to a Google Cloud Platform (GCP) `Project`.",
"id": "ProjectInfo",
@@ -1662,6 +1968,72 @@
},
"type": "object"
},
"RemoveAndroidAppRequest": {
"id": "RemoveAndroidAppRequest",
"properties": {
"allowMissing": {
"description": "If set to true, and the App is not found, the request will succeed but no action will be taken on the server.",
"type": "boolean"
},
"etag": {
"description": "Checksum provided in the AndroidApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.",
"type": "string"
},
"immediate": {
"description": "Determines whether to _immediately_ delete the AndroidApp. If set to true, the App is immediately deleted from the Project and cannot be restored to the Project. If not set, defaults to false, which means the App will be set to expire in 30 days. Within the 30 days, the App may be restored to the Project using UndeleteAndroidApp.",
"type": "boolean"
},
"validateOnly": {
"description": "If set to true, the request is only validated. The App will _not_ be removed.",
"type": "boolean"
}
},
"type": "object"
},
"RemoveIosAppRequest": {
"id": "RemoveIosAppRequest",
"properties": {
"allowMissing": {
"description": "If set to true, and the App is not found, the request will succeed but no action will be taken on the server.",
"type": "boolean"
},
"etag": {
"description": "Checksum provided in the IosApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.",
"type": "string"
},
"immediate": {
"description": "Determines whether to _immediately_ delete the IosApp. If set to true, the App is immediately deleted from the Project and cannot be restored to the Project. If not set, defaults to false, which means the App will be set to expire in 30 days. Within the 30 days, the App may be restored to the Project using UndeleteIosApp",
"type": "boolean"
},
"validateOnly": {
"description": "If set to true, the request is only validated. The App will _not_ be removed.",
"type": "boolean"
}
},
"type": "object"
},
"RemoveWebAppRequest": {
"id": "RemoveWebAppRequest",
"properties": {
"allowMissing": {
"description": "If set to true, and the App is not found, the request will succeed but no action will be taken on the server.",
"type": "boolean"
},
"etag": {
"description": "Checksum provided in the WebApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.",
"type": "string"
},
"immediate": {
"description": "Determines whether to _immediately_ delete the WebApp. If set to true, the App is immediately deleted from the Project and cannot be restored to the Project. If not set, defaults to false, which means the App will be set to expire in 30 days. Within the 30 days, the App may be restored to the Project using UndeleteWebApp",
"type": "boolean"
},
"validateOnly": {
"description": "If set to true, the request is only validated. The App will _not_ be removed.",
"type": "boolean"
}
},
"type": "object"
},
"SearchFirebaseAppsResponse": {
"id": "SearchFirebaseAppsResponse",
"properties": {
@@ -1784,16 +2156,59 @@
},
"type": "object"
},
"UndeleteAndroidAppRequest": {
"id": "UndeleteAndroidAppRequest",
"properties": {
"etag": {
"description": "Checksum provided in the AndroidApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.",
"type": "string"
},
"validateOnly": {
"description": "If set to true, the request is only validated. The App will _not_ be undeleted.",
"type": "boolean"
}
},
"type": "object"
},
"UndeleteIosAppRequest": {
"id": "UndeleteIosAppRequest",
"properties": {
"etag": {
"description": "Checksum provided in the IosApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.",
"type": "string"
},
"validateOnly": {
"description": "If set to true, the request is only validated. The App will _not_ be undeleted.",
"type": "boolean"
}
},
"type": "object"
},
"UndeleteWebAppRequest": {
"id": "UndeleteWebAppRequest",
"properties": {
"etag": {
"description": "Checksum provided in the WebApp resource. If provided, this checksum ensures that the client has an up-to-date value before proceeding.",
"type": "string"
},
"validateOnly": {
"description": "If set to true, the request is only validated. The App will _not_ be undeleted.",
"type": "boolean"
}
},
"type": "object"
},
"WebApp": {
"description": "Details of a Firebase App for the web.",
"id": "WebApp",
"properties": {
"apiKeyId": {
"description": "The key_id of the GCP ApiKey associated with this App. If set must have no restrictions, or only have restrictions that are valid for the associated Firebase App. Cannot be set in create requests, instead an existing valid API Key will be chosen, or if no valid API Keys exist, one will be provisioned for you. Cannot be set to an empty value in update requests.",
"description": "The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `WebApp`. Be aware that this value is the UID of the API key, _not_ the [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App's [configuration artifact](../../rest/v1beta1/projects.webApps/getConfig). If `api_key_id` is not set in requests to [`webApps.Create`](../../rest/v1beta1/projects.webApps/create), then Firebase automatically associates an `api_key_id` with the `WebApp`. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, `api_key_id` cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated `WebApp`. We recommend using the [Google Cloud Console](https://console.cloud.google.com/apis/credentials) to manage API keys.",
"type": "string"
},
"appId": {
"description": "Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. This identifier should be treated as an opaque token, as the data format is not specified.",
"description": "Output only. Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. This identifier should be treated as an opaque token, as the data format is not specified.",
"readOnly": true,
"type": "string"
},
"appUrls": {
@@ -1807,12 +2222,32 @@
"description": "The user-assigned display name for the `WebApp`.",
"type": "string"
},
"etag": {
"description": "This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about `etag` in Google's [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.",
"type": "string"
},
"name": {
"description": "The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/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.webApps#WebApp.FIELDS.app_id)).",
"type": "string"
},
"projectId": {
"description": "Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `WebApp`.",
"description": "Output only. Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `WebApp`.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The lifecycle state of the App.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"DELETED"
],
"enumDescriptions": [
"Unspecified state.",
"The App is active.",
"The App has been soft-deleted. After an App has been in the `DELETED` state for more than 30 days, it is considered expired and will be permanently deleted. Up until this time, you can restore the App by calling `Undelete` ([Android](projects.androidApps/undelete) | [iOS](projects.iosApps/undelete) | [web](projects.webApps/undelete))."
],
"readOnly": true,
"type": "string"
},
"webId": {
@@ -1828,7 +2263,7 @@
"id": "WebAppConfig",
"properties": {
"apiKey": {
"description": "The API key associated with the `WebApp`.",
"description": "The [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key associated with the `WebApp`. Note that this value is _not_ the [`apiKeyId`](../projects.webApps#WebApp.FIELDS.api_key_id) (the UID) of the API key associated with the `WebApp`.",
"type": "string"
},
"appId": {