mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2025-12-29 15:49:45 +01:00
1106 lines
46 KiB
JSON
1106 lines
46 KiB
JSON
{
|
|
"discoveryVersion": "v1",
|
|
"version_module": true,
|
|
"schemas": {
|
|
"VersionFile": {
|
|
"description": "A static content file that is part of a version.",
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"description": "Output only. The current status of a particular file in the specified\nversion.\n\u003cbr\u003eThe value will be either `pending upload` or `uploaded`.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"The default status; should not be intentionally used.",
|
|
"The file has been included in the version and is expected to be uploaded\nin the near future.",
|
|
"The file has already been uploaded to Firebase Hosting."
|
|
],
|
|
"enum": [
|
|
"STATUS_UNSPECIFIED",
|
|
"EXPECTED",
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
"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"
|
|
}
|
|
},
|
|
"id": "VersionFile"
|
|
},
|
|
"DomainProvisioning": {
|
|
"type": "object",
|
|
"properties": {
|
|
"dnsFetchTime": {
|
|
"description": "The time at which the last DNS fetch occurred.",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"certChallengeDns": {
|
|
"description": "The DNS challenge for generating a certificate.",
|
|
"$ref": "CertDnsChallenge"
|
|
},
|
|
"certStatus": {
|
|
"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."
|
|
],
|
|
"enum": [
|
|
"CERT_STATUS_UNSPECIFIED",
|
|
"CERT_PENDING",
|
|
"CERT_MISSING",
|
|
"CERT_PROCESSING",
|
|
"CERT_PROPAGATING",
|
|
"CERT_ACTIVE",
|
|
"CERT_ERROR"
|
|
],
|
|
"description": "The certificate provisioning status; updated when Firebase Hosting\nprovisions an SSL certificate for the domain.",
|
|
"type": "string"
|
|
},
|
|
"certChallengeDiscoveredTxt": {
|
|
"description": "The TXT records (for the certificate challenge) that were found at the last\nDNS fetch.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"discoveredIps": {
|
|
"description": "The IPs found at the last DNS fetch.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"expectedIps": {
|
|
"description": "The list of IPs to which the domain is expected to resolve.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"dnsStatus": {
|
|
"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\nextra (non-required) DNS records were detected.",
|
|
"All required DNS records were detected. No extra (non-required) DNS records\nwere detected.",
|
|
"The domain has at least one of the required DNS records, and it has at\nleast one extra (non-required) DNS record."
|
|
],
|
|
"enum": [
|
|
"DNS_STATUS_UNSPECIFIED",
|
|
"DNS_PENDING",
|
|
"DNS_MISSING",
|
|
"DNS_PARTIAL_MATCH",
|
|
"DNS_MATCH",
|
|
"DNS_EXTRANEOUS_MATCH"
|
|
],
|
|
"description": "The DNS record match status as of the last DNS fetch.",
|
|
"type": "string"
|
|
},
|
|
"certChallengeHttp": {
|
|
"description": "The HTTP challenge for generating a certificate.",
|
|
"$ref": "CertHttpChallenge"
|
|
}
|
|
},
|
|
"id": "DomainProvisioning",
|
|
"description": "The current certificate provisioning status information for a domain."
|
|
},
|
|
"PopulateVersionFilesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uploadRequiredHashes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "The content hashes of the specified files that need to be uploaded to the\nspecified endpoint."
|
|
},
|
|
"uploadUrl": {
|
|
"description": "The URL to which the files should be uploaded, in the format:\n\u003cbr\u003e\"https://upload-firebasehosting.googleapis.com/upload/sites/\u003cvar\u003esite-name\u003c/var\u003e/versions/\u003cvar\u003eversionID\u003c/var\u003e/files\".\n\u003cbr\u003ePerform a multipart `POST` of the Gzipped file contents to the URL\nusing a forward slash and the hash of the file appended to the end.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "PopulateVersionFilesResponse"
|
|
},
|
|
"Header": {
|
|
"properties": {
|
|
"headers": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "Required. The additional headers to add to the response.",
|
|
"type": "object"
|
|
},
|
|
"glob": {
|
|
"description": "Required. The user-supplied\n[glob pattern](/docs/hosting/full-config#section-glob) to match against\nthe request URL path.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "Header",
|
|
"description": "A `Header` defines custom headers to add to a response should the request\nURL path match the pattern.",
|
|
"type": "object"
|
|
},
|
|
"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\nchanged their email address or deleted their account.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "ActingUser",
|
|
"description": "Contains metadata about the user who performed an action, such as creating\na release or finalizing a version.",
|
|
"type": "object"
|
|
},
|
|
"DomainRedirect": {
|
|
"properties": {
|
|
"domainName": {
|
|
"description": "Required. The domain name to redirect to.",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"enumDescriptions": [
|
|
"The default redirect type; should not be intentionlly used.",
|
|
"The redirect will respond with an HTTP status code of\n`301 Moved Permanently`."
|
|
],
|
|
"enum": [
|
|
"REDIRECT_TYPE_UNSPECIFIED",
|
|
"MOVED_PERMANENTLY"
|
|
],
|
|
"description": "Required. The redirect status code.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "DomainRedirect",
|
|
"description": "Defines the behavior of a domain-level redirect. Domain redirects preserve\nthe path of the redirect but replace the requested domain with the one\nspecified in the redirect configuration.",
|
|
"type": "object"
|
|
},
|
|
"ListVersionFilesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"files": {
|
|
"description": "The list path/hashes in the specified version.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "VersionFile"
|
|
}
|
|
},
|
|
"nextPageToken": {
|
|
"description": "The pagination token, if more results exist.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "ListVersionFilesResponse"
|
|
},
|
|
"CertDnsChallenge": {
|
|
"description": "Represents a DNS certificate challenge.",
|
|
"type": "object",
|
|
"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\nsatisfy the challenge.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "CertDnsChallenge"
|
|
},
|
|
"ListDomainsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"nextPageToken": {
|
|
"description": "The pagination token, if more results exist.",
|
|
"type": "string"
|
|
},
|
|
"domains": {
|
|
"description": "The list of domains, if any exist.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "Domain"
|
|
}
|
|
}
|
|
},
|
|
"id": "ListDomainsResponse"
|
|
},
|
|
"CertHttpChallenge": {
|
|
"id": "CertHttpChallenge",
|
|
"description": "Represents an HTTP certificate challenge.",
|
|
"type": "object",
|
|
"properties": {
|
|
"token": {
|
|
"description": "The token to serve at the specified URL path to satisfy the certificate\nchallenge.",
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The URL path on which to serve the specified token to satisfy the\ncertificate challenge."
|
|
}
|
|
}
|
|
},
|
|
"Version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fileCount": {
|
|
"description": "Output only. The total number of files associated with the version.\n\u003cbr\u003eThis value is calculated after a version is `FINALIZED`.",
|
|
"format": "int64",
|
|
"type": "string"
|
|
},
|
|
"deleteUser": {
|
|
"$ref": "ActingUser",
|
|
"description": "Output only. Identifies the user who `DELETED` the version."
|
|
},
|
|
"deleteTime": {
|
|
"description": "Output only. The time at which the version was `DELETED`.",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"finalizeUser": {
|
|
"description": "Output only. Identifies the user who `FINALIZED` the version.",
|
|
"$ref": "ActingUser"
|
|
},
|
|
"labels": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "The labels used for extra metadata and/or filtering.",
|
|
"type": "object"
|
|
},
|
|
"createTime": {
|
|
"description": "Output only. The time at which the version was created.",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"versionBytes": {
|
|
"description": "Output only. The total stored bytesize of the version.\n\u003cbr\u003eThis 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"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"VERSION_STATUS_UNSPECIFIED",
|
|
"CREATED",
|
|
"FINALIZED",
|
|
"DELETED",
|
|
"ABANDONED",
|
|
"EXPIRED"
|
|
],
|
|
"description": "The deploy status of a version.\n\u003cbr\u003e\n\u003cbr\u003eFor a successful deploy, call the\n[`CreateVersion`](sites.versions/create) endpoint to make a new version\n(`CREATED` status),\n[upload all desired files](sites.versions/populateFiles) to the version,\nthen [update](sites.versions/patch) the version to the `FINALIZED` status.\n\u003cbr\u003e\n\u003cbr\u003eNote that if you leave the version in the `CREATED` state for more\nthan 12 hours, the system will automatically mark the version as\n`ABANDONED`.\n\u003cbr\u003e\n\u003cbr\u003eYou can also change the status of a version to `DELETED` by calling the\n[`DeleteVersion`](sites.versions/delete) endpoint.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"The default status; should not be intentionally used.",
|
|
"The version has been created, and content is currently being added to the\nversion.",
|
|
"All content has been added to the version, and the version can no longer be\nchanged.",
|
|
"The version has been deleted.",
|
|
"The version was not updated to `FINALIZED` within 12 hours and was\nautomatically deleted.",
|
|
"The version has fallen out of the site-configured retention window and its\nassociated files in GCS have been/been scheduled for deletion."
|
|
]
|
|
},
|
|
"config": {
|
|
"$ref": "ServingConfig",
|
|
"description": "The configuration for the behavior of the site. This configuration exists\nin the [`firebase.json`](/docs/cli/#the_firebasejson_file) file."
|
|
},
|
|
"name": {
|
|
"description": "The unique identifier for a version, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e/versions/\u003cvar\u003eversionID\u003c/var\u003e\u003c/code\u003e\nThis name is provided in the response body when you call the\n[`CreateVersion`](../sites.versions/create) endpoint.",
|
|
"type": "string"
|
|
},
|
|
"createUser": {
|
|
"description": "Output only. Identifies the user who created the version.",
|
|
"$ref": "ActingUser"
|
|
}
|
|
},
|
|
"id": "Version",
|
|
"description": "A `Version` is the collection of configuration and\n[static files](sites.versions.files) that determine how a site is displayed."
|
|
},
|
|
"ListReleasesResponse": {
|
|
"id": "ListReleasesResponse",
|
|
"type": "object",
|
|
"properties": {
|
|
"nextPageToken": {
|
|
"description": "If there are additional releases remaining beyond the ones in this\nresponse, then supply this token in the next\n[`list`](../sites.versions.files/list) call to continue with the next set\nof releases.",
|
|
"type": "string"
|
|
},
|
|
"releases": {
|
|
"description": "The list of hashes of files that still need to be uploaded, if any exist.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "Release"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Redirect": {
|
|
"description": "A `Redirect` represents the configuration for returning an HTTP redirect\nresponse given a matching request URL path.",
|
|
"type": "object",
|
|
"properties": {
|
|
"location": {
|
|
"description": "Required. The value to put in the HTTP location header of the response.\n\u003cbr\u003eThe location can contain capture group values from the pattern using a\n`\":\"` prefix to identify the segment and an optional `\"*\"` to capture the\nrest of the URL.\nFor example:\n\u003ccode\u003e\"glob\": \"/:capture*\",\n\u003cbr\u003e\"statusCode\": 301,\n\u003cbr\u003e\"location\": \"https://example.com/foo/:capture\"\u003c/code\u003e",
|
|
"type": "string"
|
|
},
|
|
"glob": {
|
|
"description": "Required. The user-supplied\n[glob pattern](/docs/hosting/full-config#section-glob) to match against\nthe request URL path.",
|
|
"type": "string"
|
|
},
|
|
"statusCode": {
|
|
"type": "integer",
|
|
"description": "Required. The status HTTP code to return in the response. It must be a\nvalid 3xx status code.",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"id": "Redirect"
|
|
},
|
|
"Release": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"enum": [
|
|
"TYPE_UNSPECIFIED",
|
|
"DEPLOY",
|
|
"ROLLBACK",
|
|
"SITE_DISABLE"
|
|
],
|
|
"description": "Explains the reason for the release.\n\u003cbr\u003eSpecify a value for this field only when creating a `SITE_DISABLE`\ntype release.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"An unspecified type. Indicates that a version was released.\n\u003cbr\u003eThis is the default value when no other `type` is explicitly\nspecified.",
|
|
"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\nas if the site never existed."
|
|
]
|
|
},
|
|
"version": {
|
|
"$ref": "Version",
|
|
"description": "Output only. The configuration and content that was released."
|
|
},
|
|
"releaseUser": {
|
|
"$ref": "ActingUser",
|
|
"description": "Output only. Identifies the user who created the release."
|
|
},
|
|
"message": {
|
|
"description": "The deploy description when the release was created. The value can be up to\n512 characters.",
|
|
"type": "string"
|
|
},
|
|
"releaseTime": {
|
|
"description": "Output only. The time at which the version is set to be public.",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Output only. The unique identifier for the release, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e/releases/\u003cvar\u003ereleaseID\u003c/var\u003e\u003c/code\u003e\nThis name is provided in the response body when you call the\n[`CreateRelease`](sites.releases/create) endpoint.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "Release",
|
|
"description": "A `Release` is a particular\n[collection of configurations and files](sites.versions)\nthat is set to be public at a particular time."
|
|
},
|
|
"Rewrite": {
|
|
"description": "A `Rewrite` represents an internal content rewrite on the version. If the\npattern matches, the request will be handled as if it were to the\ndestination path specified in the configuration.",
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"description": "The URL path to rewrite the request to.",
|
|
"type": "string"
|
|
},
|
|
"function": {
|
|
"description": "The function to proxy requests to. Must match the exported function\nname exactly.",
|
|
"type": "string"
|
|
},
|
|
"dynamicLinks": {
|
|
"description": "The request will be forwarded to Firebase Dynamic Links.",
|
|
"type": "boolean"
|
|
},
|
|
"glob": {
|
|
"description": "Required. The user-supplied\n[glob pattern](/docs/hosting/full-config#section-glob) to match against\nthe request URL path.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "Rewrite"
|
|
},
|
|
"PopulateVersionFilesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"files": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "A set of file paths to the hashes corresponding to assets that should be\nadded to the version. Note that a file path to an empty hash will remove\nthe path from the version. Calculate a hash by Gzipping the file then\ntaking the SHA256 hash of the newly compressed file.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"id": "PopulateVersionFilesRequest"
|
|
},
|
|
"ServingConfig": {
|
|
"properties": {
|
|
"rewrites": {
|
|
"description": "A list of rewrites that will act as if the service were given the\ndestination URL.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "Rewrite"
|
|
}
|
|
},
|
|
"redirects": {
|
|
"description": "A list of globs that will cause the response to redirect to another\nlocation.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "Redirect"
|
|
}
|
|
},
|
|
"headers": {
|
|
"description": "A list of custom response headers that are added to the content if the\nrequest URL path matches the glob.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "Header"
|
|
}
|
|
},
|
|
"appAssociation": {
|
|
"enumDescriptions": [
|
|
"The app association files will be automattically created from the apps\nthat exist in the Firebase project.",
|
|
"No special handling of the app association files will occur, these paths\nwill result in a 404 unless caught with a Rewrite."
|
|
],
|
|
"enum": [
|
|
"AUTO",
|
|
"NONE"
|
|
],
|
|
"description": "How to handle well known App Association files.",
|
|
"type": "string"
|
|
},
|
|
"cleanUrls": {
|
|
"description": "Defines whether to drop the file extension from uploaded files.",
|
|
"type": "boolean"
|
|
},
|
|
"trailingSlashBehavior": {
|
|
"enumDescriptions": [
|
|
"No behavior is specified.\n\u003cbr\u003eFiles are served at their exact location only, and trailing slashes\nare only added to directory indexes.",
|
|
"Trailing slashes are _added_ to directory indexes as well as to any URL\npath not ending in a file extension.",
|
|
"Trailing slashes are _removed_ from directory indexes as well as from any\nURL path not ending in a file extension."
|
|
],
|
|
"enum": [
|
|
"TRAILING_SLASH_BEHAVIOR_UNSPECIFIED",
|
|
"ADD",
|
|
"REMOVE"
|
|
],
|
|
"description": "Defines how to handle a trailing slash in the URL path.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "ServingConfig",
|
|
"description": "The configuration for how incoming requests to a site should be routed and\nprocessed before serving content. The patterns are matched and applied\naccording to a specific\n[priority order](/docs/hosting/url-redirects-rewrites#section-priorities).",
|
|
"type": "object"
|
|
},
|
|
"Empty": {
|
|
"type": "object",
|
|
"properties": {},
|
|
"id": "Empty",
|
|
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
|
|
},
|
|
"Domain": {
|
|
"type": "object",
|
|
"properties": {
|
|
"domainRedirect": {
|
|
"$ref": "DomainRedirect",
|
|
"description": "If set, the domain should redirect with the provided parameters."
|
|
},
|
|
"status": {
|
|
"description": "Output only. Additional status of the domain association.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"Unspecified domain association status.",
|
|
"An operation is in progress on the domain association and no further\noperations can be performed until it is complete.",
|
|
"The domain association is active and no additional action is required.",
|
|
"The domain was previously verified in the legacy system. User must\nreverify the domain through the ownership service.",
|
|
"The domain verification has been lost and the domain is in the grace period\nbefore being removed from the Firebase Hosting site."
|
|
],
|
|
"enum": [
|
|
"DOMAIN_STATUS_UNSPECIFIED",
|
|
"DOMAIN_CHANGE_PENDING",
|
|
"DOMAIN_ACTIVE",
|
|
"DOMAIN_VERIFICATION_REQUIRED",
|
|
"DOMAIN_VERIFICATION_LOST"
|
|
]
|
|
},
|
|
"site": {
|
|
"type": "string",
|
|
"description": "Required. The site name of the association."
|
|
},
|
|
"updateTime": {
|
|
"description": "Output only. The time at which the domain was last updated.",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"domainName": {
|
|
"description": "Required. The domain name of the association.",
|
|
"type": "string"
|
|
},
|
|
"provisioning": {
|
|
"description": "Output only. Information about the provisioning of certificates and the\nhealth of the DNS resolution for the domain.",
|
|
"$ref": "DomainProvisioning"
|
|
}
|
|
},
|
|
"id": "Domain",
|
|
"description": "The intended behavior and status information of a domain."
|
|
}
|
|
},
|
|
"protocol": "rest",
|
|
"icons": {
|
|
"x32": "http://www.google.com/images/icons/product/search-32.gif",
|
|
"x16": "http://www.google.com/images/icons/product/search-16.gif"
|
|
},
|
|
"canonicalName": "Firebase Hosting",
|
|
"auth": {
|
|
"oauth2": {
|
|
"scopes": {
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only": {
|
|
"description": "View your data across Google Cloud Platform services"
|
|
},
|
|
"https://www.googleapis.com/auth/cloud-platform": {
|
|
"description": "View and manage 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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"rootUrl": "https://firebasehosting.googleapis.com/",
|
|
"ownerDomain": "google.com",
|
|
"name": "firebasehosting",
|
|
"batchPath": "batch",
|
|
"fullyEncodeReservedExpansion": true,
|
|
"title": "Firebase Hosting API",
|
|
"ownerName": "Google",
|
|
"resources": {
|
|
"sites": {
|
|
"resources": {
|
|
"domains": {
|
|
"methods": {
|
|
"delete": {
|
|
"flatPath": "v1beta1/sites/{sitesId}/domains/{domainsId}",
|
|
"path": "v1beta1/{+name}",
|
|
"id": "firebasehosting.sites.domains.delete",
|
|
"description": "Deletes the existing domain mapping on the specified site.",
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "DELETE",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/firebase"
|
|
],
|
|
"parameters": {
|
|
"name": {
|
|
"pattern": "^sites/[^/]+/domains/[^/]+$",
|
|
"location": "path",
|
|
"description": "Required. The name of the domain association to delete.",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"list": {
|
|
"httpMethod": "GET",
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"response": {
|
|
"$ref": "ListDomainsResponse"
|
|
},
|
|
"parameters": {
|
|
"pageToken": {
|
|
"description": "The next_page_token from a previous request, if provided.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"pageSize": {
|
|
"description": "The page size to return. Defaults to 50.",
|
|
"format": "int32",
|
|
"type": "integer",
|
|
"location": "query"
|
|
},
|
|
"parent": {
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^sites/[^/]+$",
|
|
"location": "path",
|
|
"description": "Required. The parent for which to list domains, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e\u003c/code\u003e"
|
|
}
|
|
},
|
|
"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}/domains",
|
|
"id": "firebasehosting.sites.domains.list",
|
|
"path": "v1beta1/{+parent}/domains",
|
|
"description": "Lists the domains for the specified site."
|
|
},
|
|
"get": {
|
|
"httpMethod": "GET",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"response": {
|
|
"$ref": "Domain"
|
|
},
|
|
"parameters": {
|
|
"name": {
|
|
"pattern": "^sites/[^/]+/domains/[^/]+$",
|
|
"location": "path",
|
|
"description": "Required. The name of the domain configuration to get.",
|
|
"required": true,
|
|
"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"
|
|
],
|
|
"flatPath": "v1beta1/sites/{sitesId}/domains/{domainsId}",
|
|
"id": "firebasehosting.sites.domains.get",
|
|
"path": "v1beta1/{+name}",
|
|
"description": "Gets a domain mapping on the specified site."
|
|
},
|
|
"update": {
|
|
"path": "v1beta1/{+name}",
|
|
"id": "firebasehosting.sites.domains.update",
|
|
"description": "Updates the specified domain mapping, creating the mapping as if it does\nnot exist.",
|
|
"request": {
|
|
"$ref": "Domain"
|
|
},
|
|
"response": {
|
|
"$ref": "Domain"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "PUT",
|
|
"parameters": {
|
|
"name": {
|
|
"description": "Required. The name of the domain association to update or create, if an\nassociation doesn't already exist.",
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^sites/[^/]+/domains/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/firebase"
|
|
],
|
|
"flatPath": "v1beta1/sites/{sitesId}/domains/{domainsId}"
|
|
},
|
|
"create": {
|
|
"request": {
|
|
"$ref": "Domain"
|
|
},
|
|
"description": "Creates a domain mapping on the specified site.",
|
|
"response": {
|
|
"$ref": "Domain"
|
|
},
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"httpMethod": "POST",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/firebase"
|
|
],
|
|
"parameters": {
|
|
"parent": {
|
|
"pattern": "^sites/[^/]+$",
|
|
"location": "path",
|
|
"description": "Required. The parent to create the domain association for, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e\u003c/code\u003e",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/sites/{sitesId}/domains",
|
|
"path": "v1beta1/{+parent}/domains",
|
|
"id": "firebasehosting.sites.domains.create"
|
|
}
|
|
}
|
|
},
|
|
"releases": {
|
|
"methods": {
|
|
"list": {
|
|
"flatPath": "v1beta1/sites/{sitesId}/releases",
|
|
"path": "v1beta1/{+parent}/releases",
|
|
"id": "firebasehosting.sites.releases.list",
|
|
"description": "Lists the releases that have been created on the specified site.",
|
|
"response": {
|
|
"$ref": "ListReleasesResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"httpMethod": "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"
|
|
],
|
|
"parameters": {
|
|
"pageToken": {
|
|
"location": "query",
|
|
"description": "The next_page_token from a previous request, if provided.",
|
|
"type": "string"
|
|
},
|
|
"pageSize": {
|
|
"description": "The page size to return. Defaults to 100.",
|
|
"format": "int32",
|
|
"type": "integer",
|
|
"location": "query"
|
|
},
|
|
"parent": {
|
|
"description": "Required. The parent for which to list files, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e\u003c/code\u003e",
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^sites/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
}
|
|
},
|
|
"create": {
|
|
"description": "Creates a new release which makes the content of the specified version\nactively display on the site.",
|
|
"request": {
|
|
"$ref": "Release"
|
|
},
|
|
"response": {
|
|
"$ref": "Release"
|
|
},
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"httpMethod": "POST",
|
|
"parameters": {
|
|
"parent": {
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^sites/[^/]+$",
|
|
"location": "path",
|
|
"description": "The site that the release belongs to, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e\u003c/code\u003e"
|
|
},
|
|
"versionName": {
|
|
"description": "The unique identifier for a version, in the format:\n\u003ccode\u003e/sites/\u003cvar\u003esite-name\u003c/var\u003e/versions/\u003cvar\u003eversionID\u003c/var\u003e\u003c/code\u003e\nThe \u003cvar\u003esite-name\u003c/var\u003e in this version identifier must match the\n\u003cvar\u003esite-name\u003c/var\u003e in the `parent` parameter.\n\u003cbr\u003e\n\u003cbr\u003eThis query parameter must be empty if the `type` field in the\nrequest body is `SITE_DISABLE`.",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/firebase"
|
|
],
|
|
"flatPath": "v1beta1/sites/{sitesId}/releases",
|
|
"path": "v1beta1/{+parent}/releases",
|
|
"id": "firebasehosting.sites.releases.create"
|
|
}
|
|
}
|
|
},
|
|
"versions": {
|
|
"methods": {
|
|
"patch": {
|
|
"response": {
|
|
"$ref": "Version"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"httpMethod": "PATCH",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/firebase"
|
|
],
|
|
"parameters": {
|
|
"name": {
|
|
"location": "path",
|
|
"description": "The unique identifier for a version, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e/versions/\u003cvar\u003eversionID\u003c/var\u003e\u003c/code\u003e\nThis name is provided in the response body when you call the\n[`CreateVersion`](../sites.versions/create) endpoint.",
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^sites/[^/]+/versions/[^/]+$"
|
|
},
|
|
"updateMask": {
|
|
"type": "string",
|
|
"location": "query",
|
|
"description": "A set of field names from your [version](../sites.versions) that you want\nto update.\n\u003cbr\u003eA field will be overwritten if, and only if, it's in the mask.\n\u003cbr\u003eIf a mask is not provided then a default mask of only\n[`status`](../sites.versions#Version.FIELDS.status) will be used.",
|
|
"format": "google-fieldmask"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}",
|
|
"path": "v1beta1/{+name}",
|
|
"id": "firebasehosting.sites.versions.patch",
|
|
"request": {
|
|
"$ref": "Version"
|
|
},
|
|
"description": "Updates the specified metadata for a version. Note that this method will\nfail with `FAILED_PRECONDITION` in the event of an invalid state\ntransition. The only valid transition for a version is currently from a\n`CREATED` status to a `FINALIZED` status.\nUse [`DeleteVersion`](../sites.versions/delete) to set the status of a\nversion to `DELETED`."
|
|
},
|
|
"create": {
|
|
"response": {
|
|
"$ref": "Version"
|
|
},
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"httpMethod": "POST",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/firebase"
|
|
],
|
|
"parameters": {
|
|
"parent": {
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^sites/[^/]+$",
|
|
"location": "path",
|
|
"description": "Required. The parent to create the version for, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e\u003c/code\u003e"
|
|
},
|
|
"sizeBytes": {
|
|
"description": "The self-reported size of the version. This value is used for a pre-emptive\nquota check for legacy version uploads.",
|
|
"format": "int64",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"versionId": {
|
|
"description": "A unique id for the new version. This is only specified for legacy version\ncreations.",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/sites/{sitesId}/versions",
|
|
"path": "v1beta1/{+parent}/versions",
|
|
"id": "firebasehosting.sites.versions.create",
|
|
"request": {
|
|
"$ref": "Version"
|
|
},
|
|
"description": "Creates a new version for a site."
|
|
},
|
|
"populateFiles": {
|
|
"request": {
|
|
"$ref": "PopulateVersionFilesRequest"
|
|
},
|
|
"description": "Adds content files to a version.",
|
|
"response": {
|
|
"$ref": "PopulateVersionFilesResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"httpMethod": "POST",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/firebase"
|
|
],
|
|
"parameters": {
|
|
"parent": {
|
|
"description": "Required. The version to add files to, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e/versions/\u003cvar\u003eversionID\u003c/var\u003e\u003c/code\u003e",
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^sites/[^/]+/versions/[^/]+$",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}:populateFiles",
|
|
"path": "v1beta1/{+parent}:populateFiles",
|
|
"id": "firebasehosting.sites.versions.populateFiles"
|
|
},
|
|
"delete": {
|
|
"description": "Deletes the specified version.",
|
|
"httpMethod": "DELETE",
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"parameters": {
|
|
"name": {
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^sites/[^/]+/versions/[^/]+$",
|
|
"location": "path",
|
|
"description": "Required. The name of the version to be deleted, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e/versions/\u003cvar\u003eversionID\u003c/var\u003e\u003c/code\u003e"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/firebase"
|
|
],
|
|
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}",
|
|
"id": "firebasehosting.sites.versions.delete",
|
|
"path": "v1beta1/{+name}"
|
|
}
|
|
},
|
|
"resources": {
|
|
"files": {
|
|
"methods": {
|
|
"list": {
|
|
"description": "Lists the remaining files to be uploaded for the specified version.",
|
|
"response": {
|
|
"$ref": "ListVersionFilesResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"parent"
|
|
],
|
|
"httpMethod": "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"
|
|
],
|
|
"parameters": {
|
|
"pageToken": {
|
|
"description": "The next_page_token from a previous request, if provided. This will be the\nencoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"pageSize": {
|
|
"location": "query",
|
|
"description": "The page size to return. Defaults to 1000.",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"parent": {
|
|
"description": "Required. The parent to list files for, in the format:\n\u003ccode\u003esites/\u003cvar\u003esite-name\u003c/var\u003e/versions/\u003cvar\u003eversionID\u003c/var\u003e\u003c/code\u003e",
|
|
"required": true,
|
|
"type": "string",
|
|
"pattern": "^sites/[^/]+/versions/[^/]+$",
|
|
"location": "path"
|
|
},
|
|
"status": {
|
|
"enum": [
|
|
"STATUS_UNSPECIFIED",
|
|
"EXPECTED",
|
|
"ACTIVE"
|
|
],
|
|
"description": "The type of files in the version that should be listed.",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}/files",
|
|
"path": "v1beta1/{+parent}/files",
|
|
"id": "firebasehosting.sites.versions.files.list"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": {
|
|
"access_token": {
|
|
"description": "OAuth access token.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"key": {
|
|
"location": "query",
|
|
"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"
|
|
},
|
|
"upload_protocol": {
|
|
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"quotaUser": {
|
|
"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.",
|
|
"type": "string"
|
|
},
|
|
"prettyPrint": {
|
|
"description": "Returns response with indentations and line breaks.",
|
|
"type": "boolean",
|
|
"default": "true",
|
|
"location": "query"
|
|
},
|
|
"fields": {
|
|
"type": "string",
|
|
"location": "query",
|
|
"description": "Selector specifying which fields to include in a partial response."
|
|
},
|
|
"uploadType": {
|
|
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"callback": {
|
|
"location": "query",
|
|
"description": "JSONP",
|
|
"type": "string"
|
|
},
|
|
"oauth_token": {
|
|
"location": "query",
|
|
"description": "OAuth 2.0 token for the current user.",
|
|
"type": "string"
|
|
},
|
|
"$.xgafv": {
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"v1 error format",
|
|
"v2 error format"
|
|
],
|
|
"location": "query",
|
|
"enum": [
|
|
"1",
|
|
"2"
|
|
],
|
|
"description": "V1 error format."
|
|
},
|
|
"alt": {
|
|
"enum": [
|
|
"json",
|
|
"media",
|
|
"proto"
|
|
],
|
|
"type": "string",
|
|
"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",
|
|
"description": "Data format for response.",
|
|
"default": "json"
|
|
}
|
|
},
|
|
"version": "v1beta1",
|
|
"baseUrl": "https://firebasehosting.googleapis.com/",
|
|
"kind": "discovery#restDescription",
|
|
"description": "",
|
|
"servicePath": "",
|
|
"basePath": "",
|
|
"revision": "20181011",
|
|
"documentationLink": "https://firebase.google.com/docs/hosting/",
|
|
"id": "firebasehosting:v1beta1"
|
|
}
|