Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / refs/heads/release-v1.13.0 / . / googleapiclient / discovery_cache / documents / firebasehosting.v1beta1.json
blob: d463e71eeb2d3e168eca07028a0bc63485c15933 [file] [log] [blame] [edit]
{
"kind": "discovery#restDescription",
"version_module": true,
"title": "Firebase Hosting API",
"name": "firebasehosting",
"canonicalName": "Firebase Hosting",
"batchPath": "batch",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest",
"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/firebase.readonly": {
"description": "View all your Firebase data and settings"
},
"https://www.googleapis.com/auth/firebase": {
"description": "View and administer all your Firebase data and settings"
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
}
}
}
},
"fullyEncodeReservedExpansion": true,
"schemas": {
"PathFilter": {
"description": "A representation of filter path.",
"id": "PathFilter",
"properties": {
"regexes": {
"description": "An array of regexes to filter by.",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"Empty": {
"properties": {},
"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 `{}`.",
"type": "object",
"id": "Empty"
},
"Operation": {
"properties": {
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "Status"
},
"done": {
"type": "boolean",
"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."
},
"metadata": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"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": {
"type": "string",
"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}`."
},
"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"
}
},
"id": "Operation",
"description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object"
},
"CloudRunRewrite": {
"type": "object",
"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).",
"properties": {
"region": {
"description": "Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.",
"type": "string"
},
"serviceId": {
"type": "string",
"description": "Required. User-defined ID of the Cloud Run service."
}
},
"id": "CloudRunRewrite"
},
"Rewrite": {
"properties": {
"glob": {
"description": "The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.",
"type": "string"
},
"dynamicLinks": {
"description": "The request will be forwarded to Firebase Dynamic Links.",
"type": "boolean"
},
"regex": {
"type": "string",
"description": "The user-supplied RE2 regular expression to match against the request URL path."
},
"function": {
"type": "string",
"description": "The function to proxy requests to. Must match the exported function name exactly."
},
"path": {
"description": "The URL path to rewrite the request to.",
"type": "string"
},
"run": {
"description": "The request will be forwarded to Cloud Run.",
"$ref": "CloudRunRewrite"
}
},
"id": "Rewrite",
"type": "object",
"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."
},
"ListDomainsResponse": {
"properties": {
"nextPageToken": {
"description": "The pagination token, if more results exist.",
"type": "string"
},
"domains": {
"type": "array",
"items": {
"$ref": "Domain"
},
"description": "The list of domains, if any exist."
}
},
"description": "The response to listing Domains.",
"id": "ListDomainsResponse",
"type": "object"
},
"CertHttpChallenge": {
"type": "object",
"description": "Represents an HTTP certificate challenge.",
"id": "CertHttpChallenge",
"properties": {
"token": {
"type": "string",
"description": "The token to serve at the specified URL path to satisfy the certificate challenge."
},
"path": {
"type": "string",
"description": "The URL path on which to serve the specified token to satisfy the certificate challenge."
}
}
},
"CloneVersionRequest": {
"type": "object",
"id": "CloneVersionRequest",
"description": "The request sent to CloneVersion.",
"properties": {
"finalize": {
"type": "boolean",
"description": "If true, immediately finalize the version after cloning is complete."
},
"sourceVersion": {
"description": "Required. The name of the version to be cloned, in the format: `sites/{site}/versions/{version}`",
"type": "string"
},
"include": {
"description": "If provided, only paths that match one or more regexes in this list will be included in the new version.",
"$ref": "PathFilter"
},
"exclude": {
"description": "If provided, only paths that do not match any of the regexes in this list will be included in the new version.",
"$ref": "PathFilter"
}
}
},
"ActingUser": {
"type": "object",
"id": "ActingUser",
"properties": {
"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"
},
"email": {
"description": "The email address of the user when the user performed the action.",
"type": "string"
}
},
"description": "Contains metadata about the user who performed an action, such as creating a release or finalizing a version."
},
"ListReleasesResponse": {
"type": "object",
"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": {
"type": "array",
"items": {
"$ref": "Release"
},
"description": "The list of hashes of files that still need to be uploaded, if any exist."
}
}
},
"ListVersionsResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"type": "string",
"description": "The pagination token, if more results exist"
},
"versions": {
"items": {
"$ref": "Version"
},
"description": "The list of versions, if any exist.",
"type": "array"
}
},
"id": "ListVersionsResponse"
},
"DomainRedirect": {
"type": "object",
"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.",
"properties": {
"domainName": {
"type": "string",
"description": "Required. The domain name to redirect to."
},
"type": {
"enum": [
"REDIRECT_TYPE_UNSPECIFIED",
"MOVED_PERMANENTLY"
],
"type": "string",
"enumDescriptions": [
"The default redirect type; should not be intentionlly used.",
"The redirect will respond with an HTTP status code of `301 Moved Permanently`."
],
"description": "Required. The redirect status code."
}
},
"id": "DomainRedirect"
},
"ListVersionFilesResponse": {
"id": "ListVersionFilesResponse",
"type": "object",
"properties": {
"files": {
"items": {
"$ref": "VersionFile"
},
"type": "array",
"description": "The list path/hashes in the specified version."
},
"nextPageToken": {
"description": "The pagination token, if more results exist.",
"type": "string"
}
}
},
"I18nConfig": {
"type": "object",
"description": "If provided, i18n rewrites are enabled.",
"id": "I18nConfig",
"properties": {
"root": {
"type": "string",
"description": "Required. The user-supplied path where country and language specific content will be looked for within the public directory."
}
}
},
"Channel": {
"id": "Channel",
"properties": {
"retainedReleaseCount": {
"format": "int32",
"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.",
"type": "integer"
},
"name": {
"description": "The fully-qualified identifier of the Channel.",
"type": "string"
},
"ttl": {
"description": "Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request.",
"type": "string",
"format": "google-duration"
},
"createTime": {
"description": "Output only. The time at which the channel was created.",
"format": "google-datetime",
"type": "string",
"readOnly": true
},
"release": {
"description": "Output only. The current release for the channel, if any.",
"$ref": "Release",
"readOnly": true
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Text labels used for extra metadata and/or filtering."
},
"url": {
"readOnly": true,
"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.",
"type": "string"
},
"expireTime": {
"type": "string",
"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"
},
"updateTime": {
"description": "Output only. The time at which the channel was last updated.",
"type": "string",
"format": "google-datetime",
"readOnly": true
}
},
"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.",
"type": "object"
},
"Release": {
"type": "object",
"description": "A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time.",
"properties": {
"message": {
"description": "The deploy description when the release was created. The value can be up to 512 characters.",
"type": "string"
},
"releaseTime": {
"type": "string",
"description": "Output only. The time at which the version is set to be public.",
"format": "google-datetime"
},
"version": {
"$ref": "Version",
"description": "Output only. The configuration and content that was released."
},
"name": {
"type": "string",
"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."
},
"releaseUser": {
"description": "Output only. Identifies the user who created the release.",
"$ref": "ActingUser"
},
"type": {
"type": "string",
"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."
]
}
},
"id": "Release"
},
"ListChannelsResponse": {
"description": "The response returned by ListChannels.",
"id": "ListChannelsResponse",
"type": "object",
"properties": {
"nextPageToken": {
"type": "string",
"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."
},
"channels": {
"description": "The list of channels.",
"items": {
"$ref": "Channel"
},
"type": "array"
}
}
},
"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.",
"properties": {
"regex": {
"type": "string",
"description": "The user-supplied RE2 regular expression to match against the request URL path."
},
"glob": {
"description": "The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.",
"type": "string"
},
"location": {
"type": "string",
"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\""
},
"statusCode": {
"format": "int32",
"type": "integer",
"description": "Required. The status HTTP code to return in the response. It must be a valid 3xx status code."
}
},
"id": "Redirect",
"type": "object"
},
"DomainProvisioning": {
"description": "The current certificate provisioning status information for a domain.",
"properties": {
"certStatus": {
"description": "The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.",
"type": "string",
"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."
]
},
"dnsFetchTime": {
"type": "string",
"format": "google-datetime",
"description": "The time at which the last DNS fetch occurred."
},
"certChallengeHttp": {
"description": "The HTTP challenge for generating a certificate.",
"$ref": "CertHttpChallenge"
},
"certChallengeDns": {
"$ref": "CertDnsChallenge",
"description": "The DNS challenge for generating a certificate."
},
"dnsStatus": {
"enum": [
"DNS_STATUS_UNSPECIFIED",
"DNS_PENDING",
"DNS_MISSING",
"DNS_PARTIAL_MATCH",
"DNS_MATCH",
"DNS_EXTRANEOUS_MATCH"
],
"type": "string",
"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."
],
"description": "The DNS record match status as of the last DNS fetch."
},
"discoveredIps": {
"description": "The IPs found at the last DNS fetch.",
"type": "array",
"items": {
"type": "string"
}
},
"certChallengeDiscoveredTxt": {
"description": "The TXT records (for the certificate challenge) that were found at the last DNS fetch.",
"items": {
"type": "string"
},
"type": "array"
},
"expectedIps": {
"items": {
"type": "string"
},
"type": "array",
"description": "The list of IPs to which the domain is expected to resolve."
}
},
"id": "DomainProvisioning",
"type": "object"
},
"SiteConfig": {
"id": "SiteConfig",
"type": "object",
"properties": {
"cloudLoggingEnabled": {
"type": "boolean",
"description": "Whether or not web requests made by site visitors are logged via Cloud Logging."
},
"maxVersions": {
"format": "int64",
"type": "string",
"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."
}
},
"description": "A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior"
},
"PreviewConfig": {
"id": "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. Deprecated in favor of site channels.",
"properties": {
"active": {
"description": "If true, preview URLs are enabled for this version.",
"type": "boolean"
},
"expireTime": {
"format": "google-datetime",
"type": "string",
"description": "Indicates the expiration time for previewing this version; preview URL requests received after this time will 404."
}
},
"type": "object"
},
"PopulateVersionFilesResponse": {
"id": "PopulateVersionFilesResponse",
"properties": {
"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"
},
"uploadRequiredHashes": {
"description": "The content hashes of the specified files that need to be uploaded to the specified endpoint.",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"ServingConfig": {
"id": "ServingConfig",
"properties": {
"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."
},
"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": {
"enum": [
"TRAILING_SLASH_BEHAVIOR_UNSPECIFIED",
"ADD",
"REMOVE"
],
"type": "string",
"description": "Defines how to handle a trailing slash in the URL path.",
"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."
]
},
"redirects": {
"type": "array",
"items": {
"$ref": "Redirect"
},
"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."
},
"cleanUrls": {
"type": "boolean",
"description": "Defines whether to drop the file extension from uploaded files."
},
"appAssociation": {
"enum": [
"AUTO",
"NONE"
],
"description": "How to handle well known App Association files.",
"type": "string",
"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."
]
}
},
"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).",
"type": "object"
},
"VersionFile": {
"id": "VersionFile",
"type": "object",
"properties": {
"status": {
"type": "string",
"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."
]
},
"path": {
"description": "The URI at which the file's content should display.",
"type": "string"
},
"hash": {
"type": "string",
"description": "The SHA256 content hash of the file."
}
},
"description": "A static content file that is part of a version."
},
"Version": {
"description": "A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed.",
"properties": {
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The labels used for extra metadata and/or filtering."
},
"deleteTime": {
"type": "string",
"description": "Output only. The time at which the version was `DELETED`.",
"format": "google-datetime"
},
"finalizeTime": {
"type": "string",
"description": "Output only. The time at which the version was `FINALIZED`.",
"format": "google-datetime"
},
"createUser": {
"$ref": "ActingUser",
"description": "Output only. Identifies the user who created the version."
},
"finalizeUser": {
"description": "Output only. Identifies the user who `FINALIZED` the version.",
"$ref": "ActingUser"
},
"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.",
"type": "string",
"format": "google-datetime"
},
"fileCount": {
"type": "string",
"format": "int64",
"description": "Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`."
},
"deleteUser": {
"description": "Output only. Identifies the user who `DELETED` the version.",
"$ref": "ActingUser"
},
"versionBytes": {
"type": "string",
"description": "Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.",
"format": "int64"
},
"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.",
"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",
"enum": [
"VERSION_STATUS_UNSPECIFIED",
"CREATED",
"FINALIZED",
"DELETED",
"ABANDONED",
"EXPIRED",
"CLONING"
]
},
"preview": {
"$ref": "PreviewConfig",
"description": "Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies 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."
},
"name": {
"type": "string",
"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": "object",
"id": "Version"
},
"PopulateVersionFilesRequest": {
"description": "The request to populate a Version's Files.",
"id": "PopulateVersionFilesRequest",
"properties": {
"files": {
"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.",
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"Domain": {
"id": "Domain",
"properties": {
"domainRedirect": {
"description": "If set, the domain should redirect with the provided parameters.",
"$ref": "DomainRedirect"
},
"status": {
"enum": [
"DOMAIN_STATUS_UNSPECIFIED",
"DOMAIN_CHANGE_PENDING",
"DOMAIN_ACTIVE",
"DOMAIN_VERIFICATION_REQUIRED",
"DOMAIN_VERIFICATION_LOST"
],
"type": "string",
"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."
],
"description": "Output only. Additional status of the domain association."
},
"site": {
"type": "string",
"description": "Required. The site name of the association."
},
"domainName": {
"description": "Required. The domain name of the association.",
"type": "string"
},
"updateTime": {
"type": "string",
"description": "Output only. The time at which the domain was last updated.",
"format": "google-datetime"
},
"provisioning": {
"$ref": "DomainProvisioning",
"description": "Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain."
}
},
"type": "object",
"description": "The intended behavior and status information of a domain."
},
"CertDnsChallenge": {
"type": "object",
"id": "CertDnsChallenge",
"properties": {
"token": {
"type": "string",
"description": "The value that must be present as a TXT record on the domain name to satisfy the challenge."
},
"domainName": {
"description": "The domain name upon which the DNS challenge must be satisfied.",
"type": "string"
}
},
"description": "Represents a DNS certificate challenge."
},
"Header": {
"type": "object",
"properties": {
"glob": {
"type": "string",
"description": "The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path."
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Required. The additional headers to add to the response."
},
"regex": {
"type": "string",
"description": "The user-supplied RE2 regular expression to match against the request URL path."
}
},
"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"
},
"Status": {
"id": "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).",
"properties": {
"code": {
"type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32"
},
"details": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
}
},
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use."
},
"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"
}
},
"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.",
"ownerDomain": "google.com",
"version": "v1beta1",
"documentationLink": "https://firebase.google.com/docs/hosting/",
"servicePath": "",
"parameters": {
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"alt": {
"location": "query",
"default": "json",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"type": "string",
"enum": [
"json",
"media",
"proto"
],
"description": "Data format for response."
},
"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.",
"type": "string",
"location": "query"
},
"$.xgafv": {
"enum": [
"1",
"2"
],
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"description": "V1 error format.",
"location": "query"
},
"upload_protocol": {
"type": "string",
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"quotaUser": {
"type": "string",
"location": "query",
"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."
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
"type": "boolean",
"default": "true",
"location": "query",
"description": "Returns response with indentations and line breaks."
},
"access_token": {
"location": "query",
"type": "string",
"description": "OAuth access token."
}
},
"baseUrl": "https://firebasehosting.googleapis.com/",
"discoveryVersion": "v1",
"rootUrl": "https://firebasehosting.googleapis.com/",
"resources": {
"sites": {
"resources": {
"channels": {
"methods": {
"list": {
"parameters": {
"pageSize": {
"type": "integer",
"location": "query",
"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"
},
"parent": {
"type": "string",
"required": true,
"location": "path",
"description": "Required. The site from which to list channels.",
"pattern": "^sites/[^/]+$"
},
"pageToken": {
"location": "query",
"description": "The next_page_token from a previous request, if provided.",
"type": "string"
}
},
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"flatPath": "v1beta1/sites/{sitesId}/channels",
"id": "firebasehosting.sites.channels.list",
"description": "Lists the channels for the specified site. All sites have a default \"live\" channel.",
"path": "v1beta1/{+parent}/channels",
"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"
],
"response": {
"$ref": "ListChannelsResponse"
}
},
"delete": {
"description": "Deletes a channel of a site. The `live` channel cannot be deleted.",
"httpMethod": "DELETE",
"id": "firebasehosting.sites.channels.delete",
"parameterOrder": [
"name"
],
"path": "v1beta1/{+name}",
"flatPath": "v1beta1/sites/{sitesId}/channels/{channelsId}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"parameters": {
"name": {
"location": "path",
"type": "string",
"pattern": "^sites/[^/]+/channels/[^/]+$",
"description": "Required. The fully-qualified identifier for the site.",
"required": true
}
},
"response": {
"$ref": "Empty"
}
},
"get": {
"response": {
"$ref": "Channel"
},
"parameters": {
"name": {
"description": "Required. The fully-qualified identifier for the channel.",
"type": "string",
"pattern": "^sites/[^/]+/channels/[^/]+$",
"required": true,
"location": "path"
}
},
"httpMethod": "GET",
"path": "v1beta1/{+name}",
"id": "firebasehosting.sites.channels.get",
"description": "Retrieves information for the specified channel of a site.",
"flatPath": "v1beta1/sites/{sitesId}/channels/{channelsId}",
"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"
],
"parameterOrder": [
"name"
]
},
"patch": {
"parameterOrder": [
"name"
],
"path": "v1beta1/{+name}",
"description": "Updates information for the specified channel of a site. This method will implicitly create a channel if it doesn't exist.",
"request": {
"$ref": "Channel"
},
"parameters": {
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"type": "string",
"description": "A comma-separated list of fields to be updated in this request."
},
"name": {
"description": "The fully-qualified identifier of the Channel.",
"type": "string",
"location": "path",
"pattern": "^sites/[^/]+/channels/[^/]+$",
"required": true
}
},
"response": {
"$ref": "Channel"
},
"flatPath": "v1beta1/sites/{sitesId}/channels/{channelsId}",
"httpMethod": "PATCH",
"id": "firebasehosting.sites.channels.patch",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"create": {
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"id": "firebasehosting.sites.channels.create",
"request": {
"$ref": "Channel"
},
"path": "v1beta1/{+parent}/channels",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"response": {
"$ref": "Channel"
},
"description": "Creates a new channel in the specified site.",
"parameters": {
"channelId": {
"type": "string",
"description": "Required. Immutable. A unique id within the site to identify the channel.",
"location": "query"
},
"parent": {
"pattern": "^sites/[^/]+$",
"description": "Required. The site in which this channel should be created.",
"type": "string",
"location": "path",
"required": true
}
},
"flatPath": "v1beta1/sites/{sitesId}/channels"
}
},
"resources": {
"releases": {
"methods": {
"list": {
"path": "v1beta1/{+parent}/releases",
"description": "Lists the releases that have been created on the specified site.",
"flatPath": "v1beta1/sites/{sitesId}/channels/{channelsId}/releases",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"type": "string",
"pattern": "^sites/[^/]+/channels/[^/]+$",
"required": true,
"location": "path"
},
"pageSize": {
"location": "query",
"description": "The page size to return. Defaults to 100.",
"format": "int32",
"type": "integer"
},
"pageToken": {
"location": "query",
"description": "The next_page_token from a previous request, if provided.",
"type": "string"
}
},
"id": "firebasehosting.sites.channels.releases.list",
"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"
],
"httpMethod": "GET"
},
"create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"path": "v1beta1/{+parent}/releases",
"description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).",
"request": {
"$ref": "Release"
},
"parameterOrder": [
"parent"
],
"id": "firebasehosting.sites.channels.releases.create",
"httpMethod": "POST",
"response": {
"$ref": "Release"
},
"parameters": {
"parent": {
"pattern": "^sites/[^/]+/channels/[^/]+$",
"type": "string",
"description": "Required. The site that the release belongs to, in the format: sites/ site-name",
"location": "path",
"required": true
},
"versionName": {
"location": "query",
"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`.",
"type": "string"
}
},
"flatPath": "v1beta1/sites/{sitesId}/channels/{channelsId}/releases"
}
}
}
}
},
"versions": {
"resources": {
"files": {
"methods": {
"list": {
"response": {
"$ref": "ListVersionFilesResponse"
},
"parameters": {
"status": {
"description": "The type of files in the version that should be listed.",
"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",
"enum": [
"STATUS_UNSPECIFIED",
"EXPECTED",
"ACTIVE"
],
"type": "string"
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "The page size to return. Defaults to 1000.",
"location": "query"
},
"pageToken": {
"location": "query",
"description": "The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.",
"type": "string"
},
"parent": {
"required": true,
"description": "Required. The parent to list files for, in the format: sites/site-name /versions/versionID",
"pattern": "^sites/[^/]+/versions/[^/]+$",
"location": "path",
"type": "string"
}
},
"description": "Lists the remaining files to be uploaded for the specified version.",
"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"
],
"httpMethod": "GET",
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}/files",
"parameterOrder": [
"parent"
],
"path": "v1beta1/{+parent}/files",
"id": "firebasehosting.sites.versions.files.list"
}
}
}
},
"methods": {
"list": {
"flatPath": "v1beta1/sites/{sitesId}/versions",
"id": "firebasehosting.sites.versions.list",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"description": "Lists the versions that have been created on the specified site. Will include filtering in the future.",
"parameters": {
"pageToken": {
"type": "string",
"description": "The next_page_token from a previous request, if provided.",
"location": "query"
},
"filter": {
"location": "query",
"type": "string",
"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."
},
"parent": {
"type": "string",
"location": "path",
"pattern": "^sites/[^/]+$",
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"required": true
},
"pageSize": {
"type": "integer",
"location": "query",
"format": "int32",
"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"
}
},
"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"
],
"path": "v1beta1/{+parent}/versions"
},
"populateFiles": {
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"description": "Adds content files to a version. Each file must be under 2 GB.",
"parameters": {
"parent": {
"location": "path",
"required": true,
"description": "Required. The version to add files to, in the format: sites/site-name /versions/versionID",
"pattern": "^sites/[^/]+/versions/[^/]+$",
"type": "string"
}
},
"path": "v1beta1/{+parent}:populateFiles",
"response": {
"$ref": "PopulateVersionFilesResponse"
},
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}:populateFiles",
"id": "firebasehosting.sites.versions.populateFiles",
"request": {
"$ref": "PopulateVersionFilesRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"patch": {
"response": {
"$ref": "Version"
},
"id": "firebasehosting.sites.versions.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`.",
"httpMethod": "PATCH",
"request": {
"$ref": "Version"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}",
"parameterOrder": [
"name"
],
"parameters": {
"updateMask": {
"type": "string",
"location": "query",
"format": "google-fieldmask",
"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."
},
"name": {
"location": "path",
"type": "string",
"pattern": "^sites/[^/]+/versions/[^/]+$",
"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.",
"required": true
}
},
"path": "v1beta1/{+name}"
},
"delete": {
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"pattern": "^sites/[^/]+/versions/[^/]+$",
"description": "Required. The name of the version to be deleted, in the format: sites/ site-name/versions/versionID",
"type": "string",
"location": "path",
"required": true
}
},
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}",
"path": "v1beta1/{+name}",
"response": {
"$ref": "Empty"
},
"id": "firebasehosting.sites.versions.delete",
"description": "Deletes the specified version."
},
"clone": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"parent"
],
"flatPath": "v1beta1/sites/{sitesId}/versions:clone",
"description": "Creates a new version on the target site using the content of the specified version.",
"parameters": {
"parent": {
"location": "path",
"description": "Required. The target site where the cloned version will reside, in the format: `sites/{site}`",
"required": true,
"pattern": "^sites/[^/]+$",
"type": "string"
}
},
"request": {
"$ref": "CloneVersionRequest"
},
"path": "v1beta1/{+parent}/versions:clone",
"id": "firebasehosting.sites.versions.clone",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
},
"create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"request": {
"$ref": "Version"
},
"parameters": {
"versionId": {
"type": "string",
"description": "A unique id for the new version. This is was only specified for legacy version creations, and should be blank.",
"location": "query"
},
"sizeBytes": {
"type": "string",
"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"
},
"parent": {
"required": true,
"description": "Required. The parent to create the version for, in the format: sites/ site-name",
"pattern": "^sites/[^/]+$",
"location": "path",
"type": "string"
}
},
"httpMethod": "POST",
"flatPath": "v1beta1/sites/{sitesId}/versions",
"description": "Creates a new version for a site.",
"path": "v1beta1/{+parent}/versions",
"id": "firebasehosting.sites.versions.create",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "Version"
}
}
}
},
"releases": {
"methods": {
"create": {
"flatPath": "v1beta1/sites/{sitesId}/releases",
"description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).",
"id": "firebasehosting.sites.releases.create",
"request": {
"$ref": "Release"
},
"response": {
"$ref": "Release"
},
"parameterOrder": [
"parent"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"httpMethod": "POST",
"parameters": {
"versionName": {
"type": "string",
"location": "query",
"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`."
},
"parent": {
"location": "path",
"required": true,
"type": "string",
"description": "Required. The site that the release belongs to, in the format: sites/ site-name",
"pattern": "^sites/[^/]+$"
}
},
"path": "v1beta1/{+parent}/releases"
},
"list": {
"description": "Lists the releases that have been created on the specified site.",
"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"
],
"flatPath": "v1beta1/sites/{sitesId}/releases",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"format": "int32",
"type": "integer",
"location": "query",
"description": "The page size to return. Defaults to 100."
},
"parent": {
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"location": "path",
"required": true,
"type": "string",
"pattern": "^sites/[^/]+$"
},
"pageToken": {
"type": "string",
"description": "The next_page_token from a previous request, if provided.",
"location": "query"
}
},
"path": "v1beta1/{+parent}/releases",
"id": "firebasehosting.sites.releases.list",
"response": {
"$ref": "ListReleasesResponse"
}
}
}
},
"domains": {
"methods": {
"update": {
"flatPath": "v1beta1/sites/{sitesId}/domains/{domainsId}",
"request": {
"$ref": "Domain"
},
"id": "firebasehosting.sites.domains.update",
"description": "Updates the specified domain mapping, creating the mapping as if it does not exist.",
"response": {
"$ref": "Domain"
},
"httpMethod": "PUT",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"path": "v1beta1/{+name}",
"parameters": {
"name": {
"pattern": "^sites/[^/]+/domains/[^/]+$",
"type": "string",
"location": "path",
"required": true,
"description": "Required. The name of the domain association to update or create, if an association doesn't already exist."
}
}
},
"get": {
"response": {
"$ref": "Domain"
},
"flatPath": "v1beta1/sites/{sitesId}/domains/{domainsId}",
"path": "v1beta1/{+name}",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"id": "firebasehosting.sites.domains.get",
"parameters": {
"name": {
"required": true,
"location": "path",
"type": "string",
"description": "Required. The name of the domain configuration to get.",
"pattern": "^sites/[^/]+/domains/[^/]+$"
}
},
"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"
],
"description": "Gets a domain mapping on the specified site."
},
"list": {
"response": {
"$ref": "ListDomainsResponse"
},
"description": "Lists the domains for the specified site.",
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 50.",
"type": "integer",
"format": "int32",
"location": "query"
},
"parent": {
"description": "Required. The parent for which to list domains, in the format: sites/ site-name",
"location": "path",
"required": true,
"type": "string",
"pattern": "^sites/[^/]+$"
},
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"location": "query",
"type": "string"
}
},
"id": "firebasehosting.sites.domains.list",
"path": "v1beta1/{+parent}/domains",
"httpMethod": "GET",
"flatPath": "v1beta1/sites/{sitesId}/domains",
"parameterOrder": [
"parent"
],
"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"
]
},
"create": {
"description": "Creates a domain mapping on the specified site.",
"httpMethod": "POST",
"path": "v1beta1/{+parent}/domains",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"type": "string",
"required": true,
"location": "path",
"description": "Required. The parent to create the domain association for, in the format: sites/site-name",
"pattern": "^sites/[^/]+$"
}
},
"flatPath": "v1beta1/sites/{sitesId}/domains",
"response": {
"$ref": "Domain"
},
"id": "firebasehosting.sites.domains.create",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"request": {
"$ref": "Domain"
}
},
"delete": {
"id": "firebasehosting.sites.domains.delete",
"description": "Deletes the existing domain mapping on the specified site.",
"flatPath": "v1beta1/sites/{sitesId}/domains/{domainsId}",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"httpMethod": "DELETE",
"path": "v1beta1/{+name}",
"parameters": {
"name": {
"pattern": "^sites/[^/]+/domains/[^/]+$",
"description": "Required. The name of the domain association to delete.",
"type": "string",
"location": "path",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
}
}
},
"methods": {
"updateConfig": {
"description": "Sets the Hosting metadata for a specific site.",
"flatPath": "v1beta1/sites/{sitesId}/config",
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"format": "google-fieldmask",
"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.",
"location": "query",
"type": "string"
},
"name": {
"required": true,
"pattern": "^sites/[^/]+/config$",
"location": "path",
"description": "Required. The site for which to update the SiteConfig, in the format: sites/ site-name/config",
"type": "string"
}
},
"id": "firebasehosting.sites.updateConfig",
"request": {
"$ref": "SiteConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"response": {
"$ref": "SiteConfig"
},
"path": "v1beta1/{+name}"
},
"getConfig": {
"response": {
"$ref": "SiteConfig"
},
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"flatPath": "v1beta1/sites/{sitesId}/config",
"parameters": {
"name": {
"description": "Required. The site for which to get the SiteConfig, in the format: sites/ site-name/config",
"required": true,
"pattern": "^sites/[^/]+/config$",
"type": "string",
"location": "path"
}
},
"description": "Gets the Hosting metadata for a specific site.",
"path": "v1beta1/{+name}",
"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"
],
"id": "firebasehosting.sites.getConfig"
}
}
},
"projects": {
"resources": {
"operations": {
"methods": {
"get": {
"response": {
"$ref": "Operation"
},
"id": "firebasehosting.projects.operations.get",
"path": "v1beta1/{+name}",
"parameterOrder": [
"name"
],
"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"
],
"flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "GET",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/operations/[^/]+$",
"location": "path",
"type": "string",
"required": true,
"description": "The name of the operation resource."
}
},
"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."
}
}
},
"sites": {
"methods": {
"getConfig": {
"parameters": {
"name": {
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/sites/[^/]+/config$",
"description": "Required. The site for which to get the SiteConfig, in the format: sites/ site-name/config",
"location": "path"
}
},
"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"
],
"parameterOrder": [
"name"
],
"id": "firebasehosting.projects.sites.getConfig",
"path": "v1beta1/{+name}",
"description": "Gets the Hosting metadata for a specific site.",
"httpMethod": "GET",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/config"
},
"updateConfig": {
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/config",
"id": "firebasehosting.projects.sites.updateConfig",
"path": "v1beta1/{+name}",
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"response": {
"$ref": "SiteConfig"
},
"request": {
"$ref": "SiteConfig"
},
"description": "Sets the Hosting metadata for a specific site.",
"parameters": {
"name": {
"required": true,
"description": "Required. The site for which to update the SiteConfig, in the format: sites/ site-name/config",
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/config$"
},
"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.",
"location": "query",
"format": "google-fieldmask",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
}
},
"resources": {
"domains": {
"methods": {
"create": {
"description": "Creates a domain mapping on the specified site.",
"httpMethod": "POST",
"request": {
"$ref": "Domain"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains",
"path": "v1beta1/{+parent}/domains",
"response": {
"$ref": "Domain"
},
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/sites/[^/]+$",
"location": "path",
"description": "Required. The parent to create the domain association for, in the format: sites/site-name",
"type": "string",
"required": true
}
},
"id": "firebasehosting.projects.sites.domains.create"
},
"list": {
"id": "firebasehosting.projects.sites.domains.list",
"httpMethod": "GET",
"response": {
"$ref": "ListDomainsResponse"
},
"parameterOrder": [
"parent"
],
"parameters": {
"pageToken": {
"description": "The next_page_token from a previous request, if provided.",
"type": "string",
"location": "query"
},
"parent": {
"pattern": "^projects/[^/]+/sites/[^/]+$",
"description": "Required. The parent for which to list domains, in the format: sites/ site-name",
"required": true,
"type": "string",
"location": "path"
},
"pageSize": {
"format": "int32",
"type": "integer",
"description": "The page size to return. Defaults to 50.",
"location": "query"
}
},
"description": "Lists the domains for the specified site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains",
"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"
],
"path": "v1beta1/{+parent}/domains"
},
"update": {
"httpMethod": "PUT",
"description": "Updates the specified domain mapping, creating the mapping as if it does not exist.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains/{domainsId}",
"parameters": {
"name": {
"type": "string",
"location": "path",
"required": true,
"description": "Required. The name of the domain association to update or create, if an association doesn't already exist.",
"pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$"
}
},
"path": "v1beta1/{+name}",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"id": "firebasehosting.projects.sites.domains.update",
"request": {
"$ref": "Domain"
},
"response": {
"$ref": "Domain"
}
},
"get": {
"id": "firebasehosting.projects.sites.domains.get",
"description": "Gets a domain mapping on the specified site.",
"parameterOrder": [
"name"
],
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains/{domainsId}",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$",
"required": true,
"description": "Required. The name of the domain configuration to get.",
"location": "path",
"type": "string"
}
},
"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"
],
"httpMethod": "GET",
"response": {
"$ref": "Domain"
},
"path": "v1beta1/{+name}"
},
"delete": {
"path": "v1beta1/{+name}",
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"id": "firebasehosting.projects.sites.domains.delete",
"description": "Deletes the existing domain mapping on the specified site.",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains/{domainsId}",
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$",
"required": true,
"description": "Required. The name of the domain association to delete."
}
}
}
}
},
"channels": {
"methods": {
"get": {
"id": "firebasehosting.projects.sites.channels.get",
"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"
],
"path": "v1beta1/{+name}",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"required": true,
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$",
"type": "string",
"description": "Required. The fully-qualified identifier for the channel."
}
},
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels/{channelsId}",
"httpMethod": "GET",
"response": {
"$ref": "Channel"
},
"description": "Retrieves information for the specified channel of a site."
},
"create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"response": {
"$ref": "Channel"
},
"id": "firebasehosting.projects.sites.channels.create",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels",
"parameters": {
"channelId": {
"location": "query",
"description": "Required. Immutable. A unique id within the site to identify the channel.",
"type": "string"
},
"parent": {
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/sites/[^/]+$",
"location": "path",
"description": "Required. The site in which this channel should be created."
}
},
"path": "v1beta1/{+parent}/channels",
"request": {
"$ref": "Channel"
},
"description": "Creates a new channel in the specified site.",
"httpMethod": "POST",
"parameterOrder": [
"parent"
]
},
"list": {
"description": "Lists the channels for the specified site. All sites have a default \"live\" channel.",
"httpMethod": "GET",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels",
"response": {
"$ref": "ListChannelsResponse"
},
"id": "firebasehosting.projects.sites.channels.list",
"parameters": {
"pageSize": {
"location": "query",
"type": "integer",
"format": "int32",
"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"
},
"pageToken": {
"type": "string",
"description": "The next_page_token from a previous request, if provided.",
"location": "query"
},
"parent": {
"required": true,
"description": "Required. The site from which to list channels.",
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+$"
}
},
"path": "v1beta1/{+parent}/channels",
"parameterOrder": [
"parent"
],
"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": {
"path": "v1beta1/{+name}",
"id": "firebasehosting.projects.sites.channels.patch",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels/{channelsId}",
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"parameters": {
"updateMask": {
"description": "A comma-separated list of fields to be updated in this request.",
"type": "string",
"format": "google-fieldmask",
"location": "query"
},
"name": {
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$",
"description": "The fully-qualified identifier of the Channel.",
"location": "path",
"type": "string",
"required": true
}
},
"description": "Updates information for the specified channel of a site. This method will implicitly create a channel if it doesn't exist."
},
"delete": {
"response": {
"$ref": "Empty"
},
"id": "firebasehosting.projects.sites.channels.delete",
"parameters": {
"name": {
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$",
"location": "path",
"description": "Required. The fully-qualified identifier for the site."
}
},
"parameterOrder": [
"name"
],
"description": "Deletes a channel of a site. The `live` channel cannot be deleted.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels/{channelsId}",
"path": "v1beta1/{+name}",
"httpMethod": "DELETE"
}
},
"resources": {
"releases": {
"methods": {
"create": {
"parameters": {
"versionName": {
"location": "query",
"type": "string",
"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`."
},
"parent": {
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$",
"required": true,
"type": "string",
"description": "Required. The site that the release belongs to, in the format: sites/ site-name"
}
},
"id": "firebasehosting.projects.sites.channels.releases.create",
"path": "v1beta1/{+parent}/releases",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels/{channelsId}/releases",
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).",
"request": {
"$ref": "Release"
},
"response": {
"$ref": "Release"
}
},
"list": {
"description": "Lists the releases that have been created on the specified site.",
"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"
],
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/channels/{channelsId}/releases",
"path": "v1beta1/{+parent}/releases",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"id": "firebasehosting.projects.sites.channels.releases.list",
"response": {
"$ref": "ListReleasesResponse"
},
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 100.",
"format": "int32",
"type": "integer",
"location": "query"
},
"parent": {
"type": "string",
"required": true,
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"location": "path",
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$"
},
"pageToken": {
"location": "query",
"description": "The next_page_token from a previous request, if provided.",
"type": "string"
}
}
}
}
}
}
},
"releases": {
"methods": {
"list": {
"parameters": {
"pageSize": {
"description": "The page size to return. Defaults to 100.",
"location": "query",
"type": "integer",
"format": "int32"
},
"pageToken": {
"location": "query",
"type": "string",
"description": "The next_page_token from a previous request, if provided."
},
"parent": {
"required": true,
"pattern": "^projects/[^/]+/sites/[^/]+$",
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"type": "string",
"location": "path"
}
},
"httpMethod": "GET",
"id": "firebasehosting.projects.sites.releases.list",
"path": "v1beta1/{+parent}/releases",
"description": "Lists the releases that have been created on the specified site.",
"parameterOrder": [
"parent"
],
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/releases",
"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"
],
"response": {
"$ref": "ListReleasesResponse"
}
},
"create": {
"httpMethod": "POST",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/releases",
"request": {
"$ref": "Release"
},
"id": "firebasehosting.projects.sites.releases.create",
"path": "v1beta1/{+parent}/releases",
"response": {
"$ref": "Release"
},
"description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/sites/[^/]+$",
"description": "Required. The site that the release belongs to, in the format: sites/ site-name",
"required": true,
"type": "string",
"location": "path"
},
"versionName": {
"type": "string",
"location": "query",
"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`."
}
}
}
}
},
"versions": {
"methods": {
"delete": {
"id": "firebasehosting.projects.sites.versions.delete",
"description": "Deletes the specified version.",
"parameters": {
"name": {
"description": "Required. The name of the version to be deleted, in the format: sites/ site-name/versions/versionID",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"path": "v1beta1/{+name}",
"httpMethod": "DELETE",
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
]
},
"create": {
"id": "firebasehosting.projects.sites.versions.create",
"response": {
"$ref": "Version"
},
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"request": {
"$ref": "Version"
},
"path": "v1beta1/{+parent}/versions",
"description": "Creates a new version for a site.",
"parameters": {
"versionId": {
"type": "string",
"description": "A unique id for the new version. This is was only specified for legacy version creations, and should be blank.",
"location": "query"
},
"sizeBytes": {
"format": "int64",
"description": "The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent to create the version for, in the format: sites/ site-name",
"location": "path",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/sites/[^/]+$"
}
}
},
"patch": {
"parameters": {
"updateMask": {
"type": "string",
"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.",
"location": "query",
"format": "google-fieldmask"
},
"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"
}
},
"response": {
"$ref": "Version"
},
"request": {
"$ref": "Version"
},
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}",
"path": "v1beta1/{+name}",
"id": "firebasehosting.projects.sites.versions.patch",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"httpMethod": "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`."
},
"clone": {
"httpMethod": "POST",
"id": "firebasehosting.projects.sites.versions.clone",
"path": "v1beta1/{+parent}/versions:clone",
"parameters": {
"parent": {
"required": true,
"location": "path",
"description": "Required. The target site where the cloned version will reside, in the format: `sites/{site}`",
"type": "string",
"pattern": "^projects/[^/]+/sites/[^/]+$"
}
},
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions:clone",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"parameterOrder": [
"parent"
],
"description": "Creates a new version on the target site using the content of the specified version.",
"request": {
"$ref": "CloneVersionRequest"
}
},
"populateFiles": {
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}:populateFiles",
"description": "Adds content files to a version. Each file must be under 2 GB.",
"httpMethod": "POST",
"path": "v1beta1/{+parent}:populateFiles",
"response": {
"$ref": "PopulateVersionFilesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
"parameterOrder": [
"parent"
],
"id": "firebasehosting.projects.sites.versions.populateFiles",
"request": {
"$ref": "PopulateVersionFilesRequest"
},
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$",
"location": "path",
"description": "Required. The version to add files to, in the format: sites/site-name /versions/versionID",
"required": true,
"type": "string"
}
}
},
"list": {
"id": "firebasehosting.projects.sites.versions.list",
"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"
],
"path": "v1beta1/{+parent}/versions",
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"response": {
"$ref": "ListVersionsResponse"
},
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions",
"description": "Lists the versions that have been created on the specified site. Will include filtering in the future.",
"parameters": {
"pageToken": {
"type": "string",
"description": "The next_page_token from a previous request, if provided.",
"location": "query"
},
"filter": {
"type": "string",
"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"
},
"parent": {
"type": "string",
"description": "Required. The parent for which to list files, in the format: sites/site-name",
"required": true,
"pattern": "^projects/[^/]+/sites/[^/]+$",
"location": "path"
},
"pageSize": {
"type": "integer",
"format": "int32",
"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",
"location": "query"
}
}
}
},
"resources": {
"files": {
"methods": {
"list": {
"description": "Lists the remaining files to be uploaded for the specified version.",
"path": "v1beta1/{+parent}/files",
"response": {
"$ref": "ListVersionFilesResponse"
},
"parameterOrder": [
"parent"
],
"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"
],
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}/files",
"id": "firebasehosting.projects.sites.versions.files.list",
"parameters": {
"pageSize": {
"location": "query",
"format": "int32",
"type": "integer",
"description": "The page size to return. Defaults to 1000."
},
"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.",
"type": "string",
"location": "query"
},
"parent": {
"location": "path",
"description": "Required. The parent to list files for, in the format: sites/site-name /versions/versionID",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$"
},
"status": {
"description": "The type of files in the version that should be listed.",
"location": "query",
"type": "string",
"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."
]
}
},
"httpMethod": "GET"
}
}
}
}
}
}
}
}
}
},
"basePath": "",
"ownerName": "Google",
"revision": "20201024",
"id": "firebasehosting:v1beta1",
"mtlsRootUrl": "https://firebasehosting.mtls.googleapis.com/"
}