mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
update API descriptions
This commit is contained in:
Sebastian Thiel
@@ -149,6 +149,71 @@
|
||||
}
|
||||
},
|
||||
"sites": {
|
||||
"methods": {
|
||||
"getConfig": {
|
||||
"description": "Gets the Hosting metadata for a specific site.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/config",
|
||||
"httpMethod": "GET",
|
||||
"id": "firebasehosting.projects.sites.getConfig",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The site for which to get the SiteConfig, in the format:\n<code>sites/<var>site-name</var>/config</code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+/config$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "SiteConfig"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only",
|
||||
"https://www.googleapis.com/auth/firebase",
|
||||
"https://www.googleapis.com/auth/firebase.readonly"
|
||||
]
|
||||
},
|
||||
"updateConfig": {
|
||||
"description": "Sets the Hosting metadata for a specific site.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/config",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "firebasehosting.projects.sites.updateConfig",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The site for which to update the SiteConfig, in the format:\n<code>sites/<var>site-name</var>/config</code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+/config$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "A set of field names from your [site configuration](../sites.SiteConfig)\nthat you want to update.\n<br>A field will be overwritten if, and only if, it's in the mask.\n<br>If a mask is not provided then a default mask of only\n[`max_versions`](../sites.SiteConfig.max_versions) will be used.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"request": {
|
||||
"$ref": "SiteConfig"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "SiteConfig"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/firebase"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"channels": {
|
||||
"resources": {
|
||||
@@ -164,7 +229,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The site that the release belongs to, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"description": "Required. The site that the release belongs to, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$",
|
||||
"required": true,
|
||||
@@ -231,6 +296,161 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"domains": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates a domain mapping on the specified site.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains",
|
||||
"httpMethod": "POST",
|
||||
"id": "firebasehosting.projects.sites.domains.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. The parent to create the domain association for, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/domains",
|
||||
"request": {
|
||||
"$ref": "Domain"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Domain"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/firebase"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes the existing domain mapping on the specified site.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains/{domainsId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "firebasehosting.projects.sites.domains.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The name of the domain association to delete.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/firebase"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Gets a domain mapping on the specified site.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains/{domainsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "firebasehosting.projects.sites.domains.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The name of the domain configuration to get.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Domain"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only",
|
||||
"https://www.googleapis.com/auth/firebase",
|
||||
"https://www.googleapis.com/auth/firebase.readonly"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists the domains for the specified site.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains",
|
||||
"httpMethod": "GET",
|
||||
"id": "firebasehosting.projects.sites.domains.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "The page size to return. Defaults to 50.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The next_page_token from a previous request, if provided.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. The parent for which to list domains, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/domains",
|
||||
"response": {
|
||||
"$ref": "ListDomainsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only",
|
||||
"https://www.googleapis.com/auth/firebase",
|
||||
"https://www.googleapis.com/auth/firebase.readonly"
|
||||
]
|
||||
},
|
||||
"update": {
|
||||
"description": "Updates the specified domain mapping, creating the mapping as if it does\nnot exist.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/domains/{domainsId}",
|
||||
"httpMethod": "PUT",
|
||||
"id": "firebasehosting.projects.sites.domains.update",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The name of the domain association to update or create, if an\nassociation doesn't already exist.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"request": {
|
||||
"$ref": "Domain"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Domain"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/firebase"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"releases": {
|
||||
"methods": {
|
||||
"create": {
|
||||
@@ -243,7 +463,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The site that the release belongs to, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"description": "Required. The site that the release belongs to, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+$",
|
||||
"required": true,
|
||||
@@ -307,6 +527,239 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"versions": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates a new version for a site.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions",
|
||||
"httpMethod": "POST",
|
||||
"id": "firebasehosting.projects.sites.versions.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. The parent to create the version for, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"sizeBytes": {
|
||||
"description": "The self-reported size of the version. This value is used for a pre-emptive\nquota check for legacy version uploads.",
|
||||
"format": "int64",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"versionId": {
|
||||
"description": "A unique id for the new version. This is only specified for legacy version\ncreations.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/versions",
|
||||
"request": {
|
||||
"$ref": "Version"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Version"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/firebase"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes the specified version.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "firebasehosting.projects.sites.versions.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The name of the version to be deleted, in the format:\n<code>sites/<var>site-name</var>/versions/<var>versionID</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/firebase"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists the versions that have been created on the specified site.\nWill include filtering in the future.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions",
|
||||
"httpMethod": "GET",
|
||||
"id": "firebasehosting.projects.sites.versions.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "The filter string used to return a subset of versions in the response.\nCurrently supported fields for filtering are: name, status,\nand create_time. Filter processing will be implemented in accordance\nwith go/filtering.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "The maximum number of versions to return. The service may return fewer than\nthis value.\nIf unspecified, at most 25 versions will be returned.\nThe maximum value is 100; values above 100 will be coerced to 100",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The next_page_token from a previous request, if provided.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. The parent for which to list files, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/versions",
|
||||
"response": {
|
||||
"$ref": "ListVersionsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only",
|
||||
"https://www.googleapis.com/auth/firebase",
|
||||
"https://www.googleapis.com/auth/firebase.readonly"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates the specified metadata for a version. Note that this method will\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`.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "firebasehosting.projects.sites.versions.patch",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique identifier for a version, in the format:\n<code>sites/<var>site-name</var>/versions/<var>versionID</var></code>\nThis name is provided in the response body when you call the\n[`CreateVersion`](../sites.versions/create) endpoint.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "A set of field names from your [version](../sites.versions) that you want\nto update.\n<br>A field will be overwritten if, and only if, it's in the mask.\n<br>If a mask is not provided then a default mask of only\n[`status`](../sites.versions#Version.FIELDS.status) will be used.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"request": {
|
||||
"$ref": "Version"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Version"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/firebase"
|
||||
]
|
||||
},
|
||||
"populateFiles": {
|
||||
"description": "Adds content files to a version.\nEach file must be under 2 GB.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}:populateFiles",
|
||||
"httpMethod": "POST",
|
||||
"id": "firebasehosting.projects.sites.versions.populateFiles",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. The version to add files to, in the format:\n<code>sites/<var>site-name</var>/versions/<var>versionID</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}:populateFiles",
|
||||
"request": {
|
||||
"$ref": "PopulateVersionFilesRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "PopulateVersionFilesResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/firebase"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"files": {
|
||||
"methods": {
|
||||
"list": {
|
||||
"description": "Lists the remaining files to be uploaded for the specified version.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/sites/{sitesId}/versions/{versionsId}/files",
|
||||
"httpMethod": "GET",
|
||||
"id": "firebasehosting.projects.sites.versions.files.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "The page size to return. Defaults to 1000.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The next_page_token from a previous request, if provided. This will be the\nencoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. The parent to list files for, in the format:\n<code>sites/<var>site-name</var>/versions/<var>versionID</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"description": "The type of files in the version that should be listed.",
|
||||
"enum": [
|
||||
"STATUS_UNSPECIFIED",
|
||||
"EXPECTED",
|
||||
"ACTIVE"
|
||||
],
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/files",
|
||||
"response": {
|
||||
"$ref": "ListVersionFilesResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only",
|
||||
"https://www.googleapis.com/auth/firebase",
|
||||
"https://www.googleapis.com/auth/firebase.readonly"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -393,7 +846,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The site that the release belongs to, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"description": "Required. The site that the release belongs to, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^sites/[^/]+/channels/[^/]+$",
|
||||
"required": true,
|
||||
@@ -627,7 +1080,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The site that the release belongs to, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"description": "Required. The site that the release belongs to, in the format:\n<code>sites/<var>site-name</var></code>",
|
||||
"location": "path",
|
||||
"pattern": "^sites/[^/]+$",
|
||||
"required": true,
|
||||
@@ -694,31 +1147,6 @@
|
||||
},
|
||||
"versions": {
|
||||
"methods": {
|
||||
"clone": {
|
||||
"description": "Creates a new version on the target site using the content\nof the specified version.",
|
||||
"flatPath": "v1beta1/sites/{sitesId}/versions:clone",
|
||||
"httpMethod": "POST",
|
||||
"id": "firebasehosting.sites.versions.clone",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. The target site where the cloned version will reside,\nin the format: `sites/{site}`",
|
||||
"location": "path",
|
||||
"pattern": "^sites/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/versions:clone",
|
||||
"request": {
|
||||
"$ref": "CloneVersionRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Operation"
|
||||
}
|
||||
},
|
||||
"create": {
|
||||
"description": "Creates a new version for a site.",
|
||||
"flatPath": "v1beta1/sites/{sitesId}/versions",
|
||||
@@ -821,7 +1249,13 @@
|
||||
"path": "v1beta1/{+parent}/versions",
|
||||
"response": {
|
||||
"$ref": "ListVersionsResponse"
|
||||
}
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only",
|
||||
"https://www.googleapis.com/auth/firebase",
|
||||
"https://www.googleapis.com/auth/firebase.readonly"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates the specified metadata for a version. Note that this method will\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`.",
|
||||
@@ -859,7 +1293,7 @@
|
||||
]
|
||||
},
|
||||
"populateFiles": {
|
||||
"description": "Adds content files to a version.",
|
||||
"description": "Adds content files to a version.\nEach file must be under 2 GB.",
|
||||
"flatPath": "v1beta1/sites/{sitesId}/versions/{versionsId}:populateFiles",
|
||||
"httpMethod": "POST",
|
||||
"id": "firebasehosting.sites.versions.populateFiles",
|
||||
@@ -947,7 +1381,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20200325",
|
||||
"revision": "20200709",
|
||||
"rootUrl": "https://firebasehosting.googleapis.com/",
|
||||
"schemas": {
|
||||
"ActingUser": {
|
||||
@@ -995,29 +1429,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CloneVersionRequest": {
|
||||
"description": "The request sent to CloneVersion.",
|
||||
"id": "CloneVersionRequest",
|
||||
"properties": {
|
||||
"exclude": {
|
||||
"$ref": "PathFilter",
|
||||
"description": "If provided, only paths that do not match any of the regexes in this\nlist will be included in the new version."
|
||||
},
|
||||
"finalize": {
|
||||
"description": "If true, immediately finalize the version after cloning is complete.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"include": {
|
||||
"$ref": "PathFilter",
|
||||
"description": "If provided, only paths that match one or more regexes in this list\nwill be included in the new version."
|
||||
},
|
||||
"sourceVersion": {
|
||||
"description": "Required. The name of the version to be cloned, in the format:\n`sites/{site}/versions/{version}`",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CloudRunRewrite": {
|
||||
"description": "A configured rewrite that directs requests to a Cloud Run service. If the\nCloud Run service does not exist when setting or updating your Firebase\nHosting configuration, then the request fails. Any errors from the Cloud Run\nservice are passed to the end user (for example, if you delete a service, any\nrequests directed to that service receive a `404` error).",
|
||||
"id": "CloudRunRewrite",
|
||||
@@ -1192,11 +1603,11 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Header": {
|
||||
"description": "A [`header`](/docs/hosting/full-config#headers) defines custom headers to\nadd to a response should the request URL path match the pattern.",
|
||||
"description": "A [`header`](/docs/hosting/full-config#headers) is an object that specifies\na URL pattern that, if matched to the request URL path, triggers Hosting to\napply the specified custom response headers.",
|
||||
"id": "Header",
|
||||
"properties": {
|
||||
"glob": {
|
||||
"description": "The user-supplied [glob\npattern](/docs/hosting/full-config#glob_pattern_matching) to match\nagainst the request URL path.",
|
||||
"description": "The user-supplied\n[glob](/docs/hosting/full-config#glob_pattern_matching) to match\nagainst the request URL path.",
|
||||
"type": "string"
|
||||
},
|
||||
"headers": {
|
||||
@@ -1214,6 +1625,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"ListDomainsResponse": {
|
||||
"description": "The response to listing Domains.",
|
||||
"id": "ListDomainsResponse",
|
||||
"properties": {
|
||||
"domains": {
|
||||
@@ -1316,21 +1728,8 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PathFilter": {
|
||||
"description": "A representation of filter path.",
|
||||
"id": "PathFilter",
|
||||
"properties": {
|
||||
"regexes": {
|
||||
"description": "An array of regexes to filter by.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PopulateVersionFilesRequest": {
|
||||
"description": "The request to populate a Version's Files.",
|
||||
"id": "PopulateVersionFilesRequest",
|
||||
"properties": {
|
||||
"files": {
|
||||
@@ -1377,11 +1776,11 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Redirect": {
|
||||
"description": "A [`redirect`](/docs/hosting/full-config#redirects) represents the\nconfiguration for returning an HTTP redirect response given a matching\nrequest URL path.",
|
||||
"description": "A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL\npattern that, if matched to the request URL path, triggers Hosting to\nrespond with a redirect to the specified destination path.",
|
||||
"id": "Redirect",
|
||||
"properties": {
|
||||
"glob": {
|
||||
"description": "The user-supplied [glob\npattern](/docs/hosting/full-config#glob_pattern_matching) to match\nagainst the request URL path.",
|
||||
"description": "The user-supplied\n[glob](/docs/hosting/full-config#glob_pattern_matching) to match\nagainst the request URL path.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
@@ -1445,7 +1844,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Rewrite": {
|
||||
"description": "A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal\ncontent rewrite on the version. If the pattern matches, the request will be\nhandled as if it were to the destination path specified in the\nconfiguration.",
|
||||
"description": "A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL\npattern that, if matched to the request URL path, triggers Hosting to\nrespond as if the service were given the specified destination URL.",
|
||||
"id": "Rewrite",
|
||||
"properties": {
|
||||
"dynamicLinks": {
|
||||
@@ -1457,7 +1856,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"glob": {
|
||||
"description": "The user-supplied [glob\npattern](/docs/hosting/full-config#glob_pattern_matching) to match\nagainst the request URL path.",
|
||||
"description": "The user-supplied\n[glob](/docs/hosting/full-config#glob_pattern_matching) to match\nagainst the request URL path.",
|
||||
"type": "string"
|
||||
},
|
||||
"path": {
|
||||
@@ -1476,7 +1875,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"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/full-config#hosting_priority_order).",
|
||||
"description": "The configuration for how incoming requests to a site should be routed and\nprocessed before serving content. The URL request paths are matched against\nthe specified URL patterns in the configuration, then Hosting applies the\napplicable configuration according to a specific\n[priority order](/docs/hosting/full-config#hosting_priority_order).",
|
||||
"id": "ServingConfig",
|
||||
"properties": {
|
||||
"appAssociation": {
|
||||
@@ -1496,21 +1895,21 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"headers": {
|
||||
"description": "A list of custom response headers that are added to the content if the\nrequest URL path matches the glob.",
|
||||
"description": "An array of objects, where each object specifies a URL pattern that, if\nmatched to the request URL path, triggers Hosting to apply the specified\ncustom response headers.",
|
||||
"items": {
|
||||
"$ref": "Header"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"redirects": {
|
||||
"description": "A list of globs that will cause the response to redirect to another\nlocation.",
|
||||
"description": "An array of objects (called redirect rules), where each rule specifies a\nURL pattern that, if matched to the request URL path, triggers Hosting to\nrespond with a redirect to the specified destination path.",
|
||||
"items": {
|
||||
"$ref": "Redirect"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"rewrites": {
|
||||
"description": "A list of rewrites that will act as if the service were given the\ndestination URL.",
|
||||
"description": "An array of objects (called rewrite rules), where each rule specifies a URL\npattern that, if matched to the request URL path, triggers Hosting to\nrespond as if the service were given the specified destination URL.",
|
||||
"items": {
|
||||
"$ref": "Rewrite"
|
||||
},
|
||||
@@ -1537,6 +1936,10 @@
|
||||
"description": "A `SiteConfig` contains metadata associated with a specific site that\ncontrols Firebase Hosting serving behavior",
|
||||
"id": "SiteConfig",
|
||||
"properties": {
|
||||
"cloudLoggingEnabled": {
|
||||
"description": "Whether or not web requests made by site visitors are logged via Cloud\nLogging.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"maxVersions": {
|
||||
"description": "The number of FINALIZED versions that will be held for a site before\nautomatic deletion. When a new version is deployed, content for versions\nin storage in excess of this number will be deleted, and will no longer be\nbilled for storage usage. Oldest versions will be deleted first; sites are\ncreated with an unlimited number of max_versions by default.",
|
||||
"format": "int64",
|
||||
@@ -1635,8 +2038,7 @@
|
||||
"FINALIZED",
|
||||
"DELETED",
|
||||
"ABANDONED",
|
||||
"EXPIRED",
|
||||
"CLONING"
|
||||
"EXPIRED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The default status; should not be intentionally used.",
|
||||
@@ -1644,8 +2046,7 @@
|
||||
"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 is outside the site-configured limit for the number of\nretained versions, so the version's content is scheduled for deletion.",
|
||||
"The version is being cloned from another version. All content is still\nbeing copied over."
|
||||
"The version is outside the site-configured limit for the number of\nretained versions, so the version's content is scheduled for deletion."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user