Google Git
Sign in
code / google-api-go-client / master / . / firebasehosting / v1beta1 / firebasehosting-api.json
blob: bb62d05700666dabddba55f92ac104b005811a5e [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/firebase": {
"description": "View and administer all your Firebase data and settings"
},
"https://www.googleapis.com/auth/firebase.readonly": {
"description": "View all your Firebase data and settings"
}
}
}
},
"basePath": "",
"baseUrl": "https://firebasehosting.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Firebase Hosting",
"description": "The Firebase Hosting REST API enables programmatic and customizable deployments to your Firebase-hosted sites. Use this REST API to deploy new or updated hosting configurations and content files.",
"discoveryVersion": "v1",
"documentationLink": "https://firebase.google.com/docs/hosting/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "firebasehosting:v1beta1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://firebasehosting.mtls.googleapis.com/",
"name": "firebasehosting",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "firebasehosting.projects.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
}
}
},
"sites": {
"methods": {
"getConfig": {
"description": "Gets the Hosting metadata for a specific site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/config",
"httpMethod": "GET",
"id": "firebasehosting.projects.sites.getConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The site for which to get the SiteConfig, in the format: sites/ site-name/config",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/config$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "SiteConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"updateConfig": {
"description": "Sets the Hosting metadata for a specific site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/config",
"httpMethod": "PATCH",
"id": "firebasehosting.projects.sites.updateConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The site for which to update the SiteConfig, in the format: sites/ site-name/config",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/config$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "A set of field names from your [site configuration](../sites.SiteConfig) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "SiteConfig"
},
"response": {
"$ref": "SiteConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
},
"resources": {
"channels": {
"methods": {
"create": {
"description": "Creates a new channel in the specified site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels",
"httpMethod": "POST",
"id": "firebasehosting.projects.sites.channels.create",
"parameterOrder": [
"parent"
],
"parameters": {
"channelId": {
"description": "Required. Immutable. A unique id within the site to identify the channel.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The site in which this channel should be created.",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/channels",
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"delete": {
"description": "Deletes a channel of a site. The `live` channel cannot be deleted.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels/{channelsId}",
"httpMethod": "DELETE",
"id": "firebasehosting.projects.sites.channels.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The fully-qualified identifier for the site.",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"get": {
"description": "Retrieves information for the specified channel of a site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels/{channelsId}",
"httpMethod": "GET",
"id": "firebasehosting.projects.sites.channels.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The fully-qualified identifier for the channel.",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"list": {
"description": "Lists the channels for the specified site. All sites have a default \"live\" channel.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels",
"httpMethod": "GET",
"id": "firebasehosting.projects.sites.channels.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 channels will be returned. The maximum value is 100; valuupdateses above 100 will be coerced to 100",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The site from which to list channels.",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/channels",
"response": {
"$ref": "ListChannelsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"patch": {
"description": "Updates information for the specified channel of a site. This method will implicitly create a channel if it doesn't exist.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels/{channelsId}",
"httpMethod": "PATCH",
"id": "firebasehosting.projects.sites.channels.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The fully-qualified identifier of the Channel.",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "A comma-separated list of fields to be updated in this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
},
"resources": {
"releases": {
"methods": {
"create": {
"description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels/{channelsId}/releases",
"httpMethod": "POST",
"id": "firebasehosting.projects.sites.channels.releases.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The site that the release belongs to, in the format: sites/ site-name",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string"
},
"versionName": {
"description": "The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+parent}/releases",
"request": {
"$ref": "Release"
},
"response": {
"$ref": "Release"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"list": {
"description": "Lists the releases that have been created on the specified site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels/{channelsId}/releases",
"httpMethod": "GET",
"id": "firebasehosting.projects.sites.channels.releases.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/releases",
"response": {
"$ref": "ListReleasesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
}
}
}
}
},
"domains": {
"methods": {
"create": {
"description": "Creates a domain mapping on the specified site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains",
"httpMethod": "POST",
"id": "firebasehosting.projects.sites.domains.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent to create the domain association for, in the format: sites/site-name",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/domains",
"request": {
"$ref": "Domain"
},
"response": {
"$ref": "Domain"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"delete": {
"description": "Deletes the existing domain mapping on the specified site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains/{domainsId}",
"httpMethod": "DELETE",
"id": "firebasehosting.projects.sites.domains.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the domain association to delete.",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"get": {
"description": "Gets a domain mapping on the specified site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains/{domainsId}",
"httpMethod": "GET",
"id": "firebasehosting.projects.sites.domains.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the domain configuration to get.",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Domain"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"list": {
"description": "Lists the domains for the specified site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains",
"httpMethod": "GET",
"id": "firebasehosting.projects.sites.domains.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 50.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent for which to list domains, in the format: sites/ site-name",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/domains",
"response": {
"$ref": "ListDomainsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"update": {
"description": "Updates the specified domain mapping, creating the mapping as if it does not exist.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains/{domainsId}",
"httpMethod": "PUT",
"id": "firebasehosting.projects.sites.domains.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the domain association to update or create, if an association doesn't already exist.",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Domain"
},
"response": {
"$ref": "Domain"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
}
},
"releases": {
"methods": {
"create": {
"description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/releases",
"httpMethod": "POST",
"id": "firebasehosting.projects.sites.releases.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The site that the release belongs to, in the format: sites/ site-name",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+$",
"required": true,
"type": "string"
},
"versionName": {
"description": "The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+parent}/releases",
"request": {
"$ref": "Release"
},
"response": {
"$ref": "Release"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"list": {
"description": "Lists the releases that have been created on the specified site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/releases",
"httpMethod": "GET",
"id": "firebasehosting.projects.sites.releases.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/releases",
"response": {
"$ref": "ListReleasesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
}
}
},
"versions": {
"methods": {
"clone": {
"description": "Creates a new version on the target site using the content of the specified version.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions:clone",
"httpMethod": "POST",
"id": "firebasehosting.projects.sites.versions.clone",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The target site where the cloned version will reside, in the format: `sites/{site}`",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/versions:clone",
"request": {
"$ref": "CloneVersionRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"create": {
"description": "Creates a new version for a site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions",
"httpMethod": "POST",
"id": "firebasehosting.projects.sites.versions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent to create the version for, in the format: sites/ site-name",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+$",
"required": true,
"type": "string"
},
"sizeBytes": {
"description": "The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads.",
"format": "int64",
"location": "query",
"type": "string"
},
"versionId": {
"description": "A unique id for the new version. This is was only specified for legacy version creations, and should be blank.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+parent}/versions",
"request": {
"$ref": "Version"
},
"response": {
"$ref": "Version"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"delete": {
"description": "Deletes the specified version.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}",
"httpMethod": "DELETE",
"id": "firebasehosting.projects.sites.versions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the version to be deleted, in the format: sites/ site-name/versions/versionID",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"list": {
"description": "Lists the versions that have been created on the specified site. Will include filtering in the future.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions",
"httpMethod": "GET",
"id": "firebasehosting.projects.sites.versions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter string used to return a subset of versions in the response. Currently supported fields for filtering are: name, status, and create_time. Filter processing will be implemented in accordance with go/filtering.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/versions",
"response": {
"$ref": "ListVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"patch": {
"description": "Updates the specified metadata for a version. Note that this method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The only valid transition for a version is currently from a `CREATED` status to a `FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the status of a version to `DELETED`.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}",
"httpMethod": "PATCH",
"id": "firebasehosting.projects.sites.versions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "A set of field names from your [version](../sites.versions) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`status`](../sites.versions#Version.FIELDS.status) will be used.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Version"
},
"response": {
"$ref": "Version"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"populateFiles": {
"description": "Adds content files to a version. Each file must be under 2 GB.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}:populateFiles",
"httpMethod": "POST",
"id": "firebasehosting.projects.sites.versions.populateFiles",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The version to add files to, in the format: sites/site-name /versions/versionID",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}:populateFiles",
"request": {
"$ref": "PopulateVersionFilesRequest"
},
"response": {
"$ref": "PopulateVersionFilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
},
"resources": {
"files": {
"methods": {
"list": {
"description": "Lists the remaining files to be uploaded for the specified version.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}/files",
"httpMethod": "GET",
"id": "firebasehosting.projects.sites.versions.files.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent to list files for, in the format: sites/site-name /versions/versionID",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
},
"status": {
"description": "The type of files in the version that should be listed.",
"enum": [
"STATUS_UNSPECIFIED",
"EXPECTED",
"ACTIVE"
],
"enumDescriptions": [
"The default status; should not be intentionally used.",
"The file has been included in the version and is expected to be uploaded in the near future.",
"The file has already been uploaded to Firebase Hosting."
],
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+parent}/files",
"response": {
"$ref": "ListVersionFilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
}
}
}
}
}
}
}
}
},
"sites": {
"methods": {
"getConfig": {
"description": "Gets the Hosting metadata for a specific site.",
"flatPath": "v1beta1/sites/{sitesId}/config",
"httpMethod": "GET",
"id": "firebasehosting.sites.getConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The site for which to get the SiteConfig, in the format: sites/ site-name/config",
"location": "path",
"pattern": "^sites/[^/]+/config$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "SiteConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"updateConfig": {
"description": "Sets the Hosting metadata for a specific site.",
"flatPath": "v1beta1/sites/{sitesId}/config",
"httpMethod": "PATCH",
"id": "firebasehosting.sites.updateConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The site for which to update the SiteConfig, in the format: sites/ site-name/config",
"location": "path",
"pattern": "^sites/[^/]+/config$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "A set of field names from your [site configuration](../sites.SiteConfig) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "SiteConfig"
},
"response": {
"$ref": "SiteConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
},
"resources": {
"channels": {
"methods": {
"create": {
"description": "Creates a new channel in the specified site.",
"flatPath": "v1beta1/sites/{sitesId}/channels",
"httpMethod": "POST",
"id": "firebasehosting.sites.channels.create",
"parameterOrder": [
"parent"
],
"parameters": {
"channelId": {
"description": "Required. Immutable. A unique id within the site to identify the channel.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The site in which this channel should be created.",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/channels",
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"delete": {
"description": "Deletes a channel of a site. The `live` channel cannot be deleted.",
"flatPath": "v1beta1/sites/{sitesId}/channels/{channelsId}",
"httpMethod": "DELETE",
"id": "firebasehosting.sites.channels.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The fully-qualified identifier for the site.",
"location": "path",
"pattern": "^sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"get": {
"description": "Retrieves information for the specified channel of a site.",
"flatPath": "v1beta1/sites/{sitesId}/channels/{channelsId}",
"httpMethod": "GET",
"id": "firebasehosting.sites.channels.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The fully-qualified identifier for the channel.",
"location": "path",
"pattern": "^sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"list": {
"description": "Lists the channels for the specified site. All sites have a default \"live\" channel.",
"flatPath": "v1beta1/sites/{sitesId}/channels",
"httpMethod": "GET",
"id": "firebasehosting.sites.channels.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 channels will be returned. The maximum value is 100; valuupdateses above 100 will be coerced to 100",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The site from which to list channels.",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/channels",
"response": {
"$ref": "ListChannelsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"patch": {
"description": "Updates information for the specified channel of a site. This method will implicitly create a channel if it doesn't exist.",
"flatPath": "v1beta1/sites/{sitesId}/channels/{channelsId}",
"httpMethod": "PATCH",
"id": "firebasehosting.sites.channels.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The fully-qualified identifier of the Channel.",
"location": "path",
"pattern": "^sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "A comma-separated list of fields to be updated in this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
},
"resources": {
"releases": {
"methods": {
"create": {
"description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).",
"flatPath": "v1beta1/sites/{sitesId}/channels/{channelsId}/releases",
"httpMethod": "POST",
"id": "firebasehosting.sites.channels.releases.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The site that the release belongs to, in the format: sites/ site-name",
"location": "path",
"pattern": "^sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string"
},
"versionName": {
"description": "The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+parent}/releases",
"request": {
"$ref": "Release"
},
"response": {
"$ref": "Release"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"list": {
"description": "Lists the releases that have been created on the specified site.",
"flatPath": "v1beta1/sites/{sitesId}/channels/{channelsId}/releases",
"httpMethod": "GET",
"id": "firebasehosting.sites.channels.releases.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"location": "path",
"pattern": "^sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/releases",
"response": {
"$ref": "ListReleasesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
}
}
}
}
},
"domains": {
"methods": {
"create": {
"description": "Creates a domain mapping on the specified site.",
"flatPath": "v1beta1/sites/{sitesId}/domains",
"httpMethod": "POST",
"id": "firebasehosting.sites.domains.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent to create the domain association for, in the format: sites/site-name",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/domains",
"request": {
"$ref": "Domain"
},
"response": {
"$ref": "Domain"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"delete": {
"description": "Deletes the existing domain mapping on the specified site.",
"flatPath": "v1beta1/sites/{sitesId}/domains/{domainsId}",
"httpMethod": "DELETE",
"id": "firebasehosting.sites.domains.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the domain association to delete.",
"location": "path",
"pattern": "^sites/[^/]+/domains/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"get": {
"description": "Gets a domain mapping on the specified site.",
"flatPath": "v1beta1/sites/{sitesId}/domains/{domainsId}",
"httpMethod": "GET",
"id": "firebasehosting.sites.domains.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the domain configuration to get.",
"location": "path",
"pattern": "^sites/[^/]+/domains/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Domain"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"list": {
"description": "Lists the domains for the specified site.",
"flatPath": "v1beta1/sites/{sitesId}/domains",
"httpMethod": "GET",
"id": "firebasehosting.sites.domains.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 50.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent for which to list domains, in the format: sites/ site-name",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/domains",
"response": {
"$ref": "ListDomainsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"update": {
"description": "Updates the specified domain mapping, creating the mapping as if it does not exist.",
"flatPath": "v1beta1/sites/{sitesId}/domains/{domainsId}",
"httpMethod": "PUT",
"id": "firebasehosting.sites.domains.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the domain association to update or create, if an association doesn't already exist.",
"location": "path",
"pattern": "^sites/[^/]+/domains/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Domain"
},
"response": {
"$ref": "Domain"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
}
},
"releases": {
"methods": {
"create": {
"description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).",
"flatPath": "v1beta1/sites/{sitesId}/releases",
"httpMethod": "POST",
"id": "firebasehosting.sites.releases.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The site that the release belongs to, in the format: sites/ site-name",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
},
"versionName": {
"description": "The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+parent}/releases",
"request": {
"$ref": "Release"
},
"response": {
"$ref": "Release"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"list": {
"description": "Lists the releases that have been created on the specified site.",
"flatPath": "v1beta1/sites/{sitesId}/releases",
"httpMethod": "GET",
"id": "firebasehosting.sites.releases.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/releases",
"response": {
"$ref": "ListReleasesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
}
}
},
"versions": {
"methods": {
"clone": {
"description": "Creates a new version on the target site using the content of the specified version.",
"flatPath": "v1beta1/sites/{sitesId}/versions:clone",
"httpMethod": "POST",
"id": "firebasehosting.sites.versions.clone",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The target site where the cloned version will reside, in the format: `sites/{site}`",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/versions:clone",
"request": {
"$ref": "CloneVersionRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"create": {
"description": "Creates a new version for a site.",
"flatPath": "v1beta1/sites/{sitesId}/versions",
"httpMethod": "POST",
"id": "firebasehosting.sites.versions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent to create the version for, in the format: sites/ site-name",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
},
"sizeBytes": {
"description": "The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads.",
"format": "int64",
"location": "query",
"type": "string"
},
"versionId": {
"description": "A unique id for the new version. This is was only specified for legacy version creations, and should be blank.",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+parent}/versions",
"request": {
"$ref": "Version"
},
"response": {
"$ref": "Version"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"delete": {
"description": "Deletes the specified version.",
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}",
"httpMethod": "DELETE",
"id": "firebasehosting.sites.versions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the version to be deleted, in the format: sites/ site-name/versions/versionID",
"location": "path",
"pattern": "^sites/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"list": {
"description": "Lists the versions that have been created on the specified site. Will include filtering in the future.",
"flatPath": "v1beta1/sites/{sitesId}/versions",
"httpMethod": "GET",
"id": "firebasehosting.sites.versions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter string used to return a subset of versions in the response. Currently supported fields for filtering are: name, status, and create_time. Filter processing will be implemented in accordance with go/filtering.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"location": "path",
"pattern": "^sites/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}/versions",
"response": {
"$ref": "ListVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
},
"patch": {
"description": "Updates the specified metadata for a version. Note that this method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The only valid transition for a version is currently from a `CREATED` status to a `FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the status of a version to `DELETED`.",
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}",
"httpMethod": "PATCH",
"id": "firebasehosting.sites.versions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.",
"location": "path",
"pattern": "^sites/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "A set of field names from your [version](../sites.versions) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`status`](../sites.versions#Version.FIELDS.status) will be used.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Version"
},
"response": {
"$ref": "Version"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"populateFiles": {
"description": "Adds content files to a version. Each file must be under 2 GB.",
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}:populateFiles",
"httpMethod": "POST",
"id": "firebasehosting.sites.versions.populateFiles",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The version to add files to, in the format: sites/site-name /versions/versionID",
"location": "path",
"pattern": "^sites/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta1/{+parent}:populateFiles",
"request": {
"$ref": "PopulateVersionFilesRequest"
},
"response": {
"$ref": "PopulateVersionFilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
},
"resources": {
"files": {
"methods": {
"list": {
"description": "Lists the remaining files to be uploaded for the specified version.",
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}/files",
"httpMethod": "GET",
"id": "firebasehosting.sites.versions.files.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 1000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent to list files for, in the format: sites/site-name /versions/versionID",
"location": "path",
"pattern": "^sites/[^/]+/versions/[^/]+$",
"required": true,
"type": "string"
},
"status": {
"description": "The type of files in the version that should be listed.",
"enum": [
"STATUS_UNSPECIFIED",
"EXPECTED",
"ACTIVE"
],
"enumDescriptions": [
"The default status; should not be intentionally used.",
"The file has been included in the version and is expected to be uploaded in the near future.",
"The file has already been uploaded to Firebase Hosting."
],
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+parent}/files",
"response": {
"$ref": "ListVersionFilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
]
}
}
}
}
}
}
}
},
"revision": "20200914",
"rootUrl": "https://firebasehosting.googleapis.com/",
"schemas": {
"ActingUser": {
"description": "Contains metadata about the user who performed an action, such as creating a release or finalizing a version.",
"id": "ActingUser",
"properties": {
"email": {
"description": "The email address of the user when the user performed the action.",
"type": "string"
},
"imageUrl": {
"description": "A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.",
"type": "string"
}
},
"type": "object"
},
"CertDnsChallenge": {
"description": "Represents a DNS certificate challenge.",
"id": "CertDnsChallenge",
"properties": {
"domainName": {
"description": "The domain name upon which the DNS challenge must be satisfied.",
"type": "string"
},
"token": {
"description": "The value that must be present as a TXT record on the domain name to satisfy the challenge.",
"type": "string"
}
},
"type": "object"
},
"CertHttpChallenge": {
"description": "Represents an HTTP certificate challenge.",
"id": "CertHttpChallenge",
"properties": {
"path": {
"description": "The URL path on which to serve the specified token to satisfy the certificate challenge.",
"type": "string"
},
"token": {
"description": "The token to serve at the specified URL path to satisfy the certificate challenge.",
"type": "string"
}
},
"type": "object"
},
"Channel": {
"description": "A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains.",
"id": "Channel",
"properties": {
"createTime": {
"description": "Output only. The time at which the channel was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"expireTime": {
"description": "The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field.",
"format": "google-datetime",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Text labels used for extra metadata and/or filtering.",
"type": "object"
},
"name": {
"description": "The fully-qualified identifier of the Channel.",
"type": "string"
},
"release": {
"$ref": "Release",
"description": "Output only. The current release for the channel, if any.",
"readOnly": true
},
"retainedReleaseCount": {
"description": "The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels.",
"format": "int32",
"type": "integer"
},
"ttl": {
"description": "Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request.",
"format": "google-duration",
"type": "string"
},
"updateTime": {
"description": "Output only. The time at which the channel was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"url": {
"description": "Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"CloneVersionRequest": {
"description": "The request sent to CloneVersion.",
"id": "CloneVersionRequest",
"properties": {
"exclude": {
"$ref": "PathFilter",
"description": "If provided, only paths that do not match any of the regexes in this list will be included in the new version."
},
"finalize": {
"description": "If true, immediately finalize the version after cloning is complete.",
"type": "boolean"
},
"include": {
"$ref": "PathFilter",
"description": "If provided, only paths that match one or more regexes in this list will be included in the new version."
},
"sourceVersion": {
"description": "Required. The name of the version to be cloned, in the format: `sites/{site}/versions/{version}`",
"type": "string"
}
},
"type": "object"
},
"CloudRunRewrite": {
"description": "A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error).",
"id": "CloudRunRewrite",
"properties": {
"region": {
"description": "Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.",
"type": "string"
},
"serviceId": {
"description": "Required. User-defined ID of the Cloud Run service.",
"type": "string"
}
},
"type": "object"
},
"Domain": {
"description": "The intended behavior and status information of a domain.",
"id": "Domain",
"properties": {
"domainName": {
"description": "Required. The domain name of the association.",
"type": "string"
},
"domainRedirect": {
"$ref": "DomainRedirect",
"description": "If set, the domain should redirect with the provided parameters."
},
"provisioning": {
"$ref": "DomainProvisioning",
"description": "Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain."
},
"site": {
"description": "Required. The site name of the association.",
"type": "string"
},
"status": {
"description": "Output only. Additional status of the domain association.",
"enum": [
"DOMAIN_STATUS_UNSPECIFIED",
"DOMAIN_CHANGE_PENDING",
"DOMAIN_ACTIVE",
"DOMAIN_VERIFICATION_REQUIRED",
"DOMAIN_VERIFICATION_LOST"
],
"enumDescriptions": [
"Unspecified domain association status.",
"An external operation is in progress on the domain association and no further operations can be performed until it is complete. Formerly used for metabase updates. Not currently used",
"The domain association is active and no additional action is required.",
"The domain was previously verified in the legacy system. User must reverify the domain through the ownership service.",
"The domain verification has been lost and the domain is in the grace period before being removed from the Firebase Hosting site."
],
"type": "string"
},
"updateTime": {
"description": "Output only. The time at which the domain was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"DomainProvisioning": {
"description": "The current certificate provisioning status information for a domain.",
"id": "DomainProvisioning",
"properties": {
"certChallengeDiscoveredTxt": {
"description": "The TXT records (for the certificate challenge) that were found at the last DNS fetch.",
"items": {
"type": "string"
},
"type": "array"
},
"certChallengeDns": {
"$ref": "CertDnsChallenge",
"description": "The DNS challenge for generating a certificate."
},
"certChallengeHttp": {
"$ref": "CertHttpChallenge",
"description": "The HTTP challenge for generating a certificate."
},
"certStatus": {
"description": "The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.",
"enum": [
"CERT_STATUS_UNSPECIFIED",
"CERT_PENDING",
"CERT_MISSING",
"CERT_PROCESSING",
"CERT_PROPAGATING",
"CERT_ACTIVE",
"CERT_ERROR"
],
"enumDescriptions": [
"Unspecified certificate provisioning status.",
"Waiting for certificate challenge to be created.",
"Waiting for certificate challenge to be met.",
"Certificate challenge met; attempting to acquire/propagate certificate.",
"Certificate obtained; propagating to the CDN.",
"Certificate provisioned and deployed across the CDN.",
"Certificate provisioning failed in a non-recoverable manner."
],
"type": "string"
},
"discoveredIps": {
"description": "The IPs found at the last DNS fetch.",
"items": {
"type": "string"
},
"type": "array"
},
"dnsFetchTime": {
"description": "The time at which the last DNS fetch occurred.",
"format": "google-datetime",
"type": "string"
},
"dnsStatus": {
"description": "The DNS record match status as of the last DNS fetch.",
"enum": [
"DNS_STATUS_UNSPECIFIED",
"DNS_PENDING",
"DNS_MISSING",
"DNS_PARTIAL_MATCH",
"DNS_MATCH",
"DNS_EXTRANEOUS_MATCH"
],
"enumDescriptions": [
"Unspecified DNS status.",
"No DNS records have been specified for this domain yet.",
"None of the required DNS records have been detected on the domain.",
"Some of the required DNS records were detected, but not all of them. No extra (non-required) DNS records were detected.",
"All required DNS records were detected. No extra (non-required) DNS records were detected.",
"The domain has at least one of the required DNS records, and it has at least one extra (non-required) DNS record."
],
"type": "string"
},
"expectedIps": {
"description": "The list of IPs to which the domain is expected to resolve.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"DomainRedirect": {
"description": "Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration.",
"id": "DomainRedirect",
"properties": {
"domainName": {
"description": "Required. The domain name to redirect to.",
"type": "string"
},
"type": {
"description": "Required. The redirect status code.",
"enum": [
"REDIRECT_TYPE_UNSPECIFIED",
"MOVED_PERMANENTLY"
],
"enumDescriptions": [
"The default redirect type; should not be intentionlly used.",
"The redirect will respond with an HTTP status code of `301 Moved Permanently`."
],
"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 `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"Header": {
"description": "A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.",
"id": "Header",
"properties": {
"glob": {
"description": "The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.",
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "Required. The additional headers to add to the response.",
"type": "object"
},
"regex": {
"description": "The user-supplied RE2 regular expression to match against the request URL path.",
"type": "string"
}
},
"type": "object"
},
"I18nConfig": {
"description": "If provided, i18n rewrites are enabled.",
"id": "I18nConfig",
"properties": {
"root": {
"description": "Required. The user-supplied path where country and language specific content will be looked for within the public directory.",
"type": "string"
}
},
"type": "object"
},
"ListChannelsResponse": {
"description": "The response returned by ListChannels.",
"id": "ListChannelsResponse",
"properties": {
"channels": {
"description": "The list of channels.",
"items": {
"$ref": "Channel"
},
"type": "array"
},
"nextPageToken": {
"description": "If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.channels/list) call to continue with the next set of releases.",
"type": "string"
}
},
"type": "object"
},
"ListDomainsResponse": {
"description": "The response to listing Domains.",
"id": "ListDomainsResponse",
"properties": {
"domains": {
"description": "The list of domains, if any exist.",
"items": {
"$ref": "Domain"
},
"type": "array"
},
"nextPageToken": {
"description": "The pagination token, if more results exist.",
"type": "string"
}
},
"type": "object"
},
"ListReleasesResponse": {
"id": "ListReleasesResponse",
"properties": {
"nextPageToken": {
"description": "If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.versions.files/list) call to continue with the next set of releases.",
"type": "string"
},
"releases": {
"description": "The list of hashes of files that still need to be uploaded, if any exist.",
"items": {
"$ref": "Release"
},
"type": "array"
}
},
"type": "object"
},
"ListVersionFilesResponse": {
"id": "ListVersionFilesResponse",
"properties": {
"files": {
"description": "The list path/hashes in the specified version.",
"items": {
"$ref": "VersionFile"
},
"type": "array"
},
"nextPageToken": {
"description": "The pagination token, if more results exist.",
"type": "string"
}
},
"type": "object"
},
"ListVersionsResponse": {
"id": "ListVersionsResponse",
"properties": {
"nextPageToken": {
"description": "The pagination token, if more results exist",
"type": "string"
},
"versions": {
"description": "The list of versions, if any exist.",
"items": {
"$ref": "Version"
},
"type": "array"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"description": "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.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "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.",
"type": "object"
},
"name": {
"description": "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}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "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`.",
"type": "object"
}
},
"type": "object"
},
"PathFilter": {
"description": "A representation of filter path.",
"id": "PathFilter",
"properties": {
"regexes": {
"description": "An array of regexes to filter by.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PopulateVersionFilesRequest": {
"description": "The request to populate a Version's Files.",
"id": "PopulateVersionFilesRequest",
"properties": {
"files": {
"additionalProperties": {
"type": "string"
},
"description": "A set of file paths to the hashes corresponding to assets that should be added to the version. Note that a file path to an empty hash will remove the path from the version. Calculate a hash by Gzipping the file then taking the SHA256 hash of the newly compressed file.",
"type": "object"
}
},
"type": "object"
},
"PopulateVersionFilesResponse": {
"id": "PopulateVersionFilesResponse",
"properties": {
"uploadRequiredHashes": {
"description": "The content hashes of the specified files that need to be uploaded to the specified endpoint.",
"items": {
"type": "string"
},
"type": "array"
},
"uploadUrl": {
"description": "The URL to which the files should be uploaded, in the format: \"https://upload-firebasehosting.googleapis.com/upload/sites/site-name /versions/versionID/files\". Perform a multipart `POST` of the Gzipped file contents to the URL using a forward slash and the hash of the file appended to the end.",
"type": "string"
}
},
"type": "object"
},
"PreviewConfig": {
"description": "Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version.",
"id": "PreviewConfig",
"properties": {
"active": {
"description": "If true, preview URLs are enabled for this version.",
"type": "boolean"
},
"expireTime": {
"description": "Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"Redirect": {
"description": "A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.",
"id": "Redirect",
"properties": {
"glob": {
"description": "The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.",
"type": "string"
},
"location": {
"description": "Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: \"glob\": \"/:capture*\", \"statusCode\": 301, \"location\": \"https://example.com/foo/:capture\"",
"type": "string"
},
"regex": {
"description": "The user-supplied RE2 regular expression to match against the request URL path.",
"type": "string"
},
"statusCode": {
"description": "Required. The status HTTP code to return in the response. It must be a valid 3xx status code.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Release": {
"description": "A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time.",
"id": "Release",
"properties": {
"message": {
"description": "The deploy description when the release was created. The value can be up to 512 characters.",
"type": "string"
},
"name": {
"description": "Output only. The unique identifier for the release, in the format: sites/ site-name/releases/releaseID This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint.",
"type": "string"
},
"releaseTime": {
"description": "Output only. The time at which the version is set to be public.",
"format": "google-datetime",
"type": "string"
},
"releaseUser": {
"$ref": "ActingUser",
"description": "Output only. Identifies the user who created the release."
},
"type": {
"description": "Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.",
"enum": [
"TYPE_UNSPECIFIED",
"DEPLOY",
"ROLLBACK",
"SITE_DISABLE"
],
"enumDescriptions": [
"An unspecified type. Indicates that a version was released. This is the default value when no other `type` is explicitly specified.",
"A version was uploaded to Firebase Hosting and released.",
"The release points back to a previously deployed version.",
"The release prevents the site from serving content. Firebase Hosting acts as if the site never existed."
],
"type": "string"
},
"version": {
"$ref": "Version",
"description": "Output only. The configuration and content that was released."
}
},
"type": "object"
},
"Rewrite": {
"description": "A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.",
"id": "Rewrite",
"properties": {
"dynamicLinks": {
"description": "The request will be forwarded to Firebase Dynamic Links.",
"type": "boolean"
},
"function": {
"description": "The function to proxy requests to. Must match the exported function name exactly.",
"type": "string"
},
"glob": {
"description": "The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.",
"type": "string"
},
"path": {
"description": "The URL path to rewrite the request to.",
"type": "string"
},
"regex": {
"description": "The user-supplied RE2 regular expression to match against the request URL path.",
"type": "string"
},
"run": {
"$ref": "CloudRunRewrite",
"description": "The request will be forwarded to Cloud Run."
}
},
"type": "object"
},
"ServingConfig": {
"description": "The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order).",
"id": "ServingConfig",
"properties": {
"appAssociation": {
"description": "How to handle well known App Association files.",
"enum": [
"AUTO",
"NONE"
],
"enumDescriptions": [
"The app association files will be automatically created from the apps that exist in the Firebase project.",
"No special handling of the app association files will occur, these paths will result in a 404 unless caught with a Rewrite."
],
"type": "string"
},
"cleanUrls": {
"description": "Defines whether to drop the file extension from uploaded files.",
"type": "boolean"
},
"headers": {
"description": "An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.",
"items": {
"$ref": "Header"
},
"type": "array"
},
"i18n": {
"$ref": "I18nConfig",
"description": "Optional. Defines i18n rewrite behavior."
},
"redirects": {
"description": "An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.",
"items": {
"$ref": "Redirect"
},
"type": "array"
},
"rewrites": {
"description": "An array of objects (called rewrite rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.",
"items": {
"$ref": "Rewrite"
},
"type": "array"
},
"trailingSlashBehavior": {
"description": "Defines how to handle a trailing slash in the URL path.",
"enum": [
"TRAILING_SLASH_BEHAVIOR_UNSPECIFIED",
"ADD",
"REMOVE"
],
"enumDescriptions": [
"No behavior is specified. Files are served at their exact location only, and trailing slashes are only added to directory indexes.",
"Trailing slashes are _added_ to directory indexes as well as to any URL path not ending in a file extension.",
"Trailing slashes are _removed_ from directory indexes as well as from any URL path not ending in a file extension."
],
"type": "string"
}
},
"type": "object"
},
"SiteConfig": {
"description": "A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior",
"id": "SiteConfig",
"properties": {
"cloudLoggingEnabled": {
"description": "Whether or not web requests made by site visitors are logged via Cloud Logging.",
"type": "boolean"
},
"maxVersions": {
"description": "The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "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).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"Version": {
"description": "A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed.",
"id": "Version",
"properties": {
"config": {
"$ref": "ServingConfig",
"description": "The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file."
},
"createTime": {
"description": "Output only. The time at which the version was created.",
"format": "google-datetime",
"type": "string"
},
"createUser": {
"$ref": "ActingUser",
"description": "Output only. Identifies the user who created the version."
},
"deleteTime": {
"description": "Output only. The time at which the version was `DELETED`.",
"format": "google-datetime",
"type": "string"
},
"deleteUser": {
"$ref": "ActingUser",
"description": "Output only. Identifies the user who `DELETED` the version."
},
"fileCount": {
"description": "Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.",
"format": "int64",
"type": "string"
},
"finalizeTime": {
"description": "Output only. The time at which the version was `FINALIZED`.",
"format": "google-datetime",
"type": "string"
},
"finalizeUser": {
"$ref": "ActingUser",
"description": "Output only. Identifies the user who `FINALIZED` the version."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The labels used for extra metadata and/or filtering.",
"type": "object"
},
"name": {
"description": "The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.",
"type": "string"
},
"preview": {
"$ref": "PreviewConfig",
"description": "Version preview configuration for the site version. This configuration specfies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version."
},
"status": {
"description": "The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.",
"enum": [
"VERSION_STATUS_UNSPECIFIED",
"CREATED",
"FINALIZED",
"DELETED",
"ABANDONED",
"EXPIRED",
"CLONING"
],
"enumDescriptions": [
"The default status; should not be intentionally used.",
"The version has been created, and content is currently being added to the version.",
"All content has been added to the version, and the version can no longer be changed.",
"The version has been deleted.",
"The version was not updated to `FINALIZED` within 12 hours and was automatically deleted.",
"The version is outside the site-configured limit for the number of retained versions, so the version's content is scheduled for deletion.",
"The version is being cloned from another version. All content is still being copied over."
],
"type": "string"
},
"versionBytes": {
"description": "Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"VersionFile": {
"description": "A static content file that is part of a version.",
"id": "VersionFile",
"properties": {
"hash": {
"description": "The SHA256 content hash of the file.",
"type": "string"
},
"path": {
"description": "The URI at which the file's content should display.",
"type": "string"
},
"status": {
"description": "Output only. The current status of a particular file in the specified version. The value will be either `pending upload` or `uploaded`.",
"enum": [
"STATUS_UNSPECIFIED",
"EXPECTED",
"ACTIVE"
],
"enumDescriptions": [
"The default status; should not be intentionally used.",
"The file has been included in the version and is expected to be uploaded in the near future.",
"The file has already been uploaded to Firebase Hosting."
],
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Firebase Hosting API",
"version": "v1beta1",
"version_module": true
}