1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
7 },
8 "https://www.googleapis.com/auth/firebase": {
9 "description": "View and administer all your Firebase data and settings"
10 }
11 }
12 }
13 },
14 "basePath": "",
15 "baseUrl": "https://firebasehosting.googleapis.com/",
16 "batchPath": "batch",
17 "canonicalName": "Firebase Hosting",
18 "description": "The Firebase Hosting REST API enables programmatic and customizable management and deployments to your Firebase-hosted sites. Use this REST API to create and manage channels and sites as well as to deploy new or updated hosting configurations and content files.",
19 "discoveryVersion": "v1",
20 "documentationLink": "https://firebase.google.com/docs/hosting/",
21 "fullyEncodeReservedExpansion": true,
22 "icons": {
23 "x16": "http://www.google.com/images/icons/product/search-16.gif",
24 "x32": "http://www.google.com/images/icons/product/search-32.gif"
25 },
26 "id": "firebasehosting:v1",
27 "kind": "discovery#restDescription",
28 "mtlsRootUrl": "https://firebasehosting.mtls.googleapis.com/",
29 "name": "firebasehosting",
30 "ownerDomain": "google.com",
31 "ownerName": "Google",
32 "parameters": {
33 "$.xgafv": {
34 "description": "V1 error format.",
35 "enum": [
36 "1",
37 "2"
38 ],
39 "enumDescriptions": [
40 "v1 error format",
41 "v2 error format"
42 ],
43 "location": "query",
44 "type": "string"
45 },
46 "access_token": {
47 "description": "OAuth access token.",
48 "location": "query",
49 "type": "string"
50 },
51 "alt": {
52 "default": "json",
53 "description": "Data format for response.",
54 "enum": [
55 "json",
56 "media",
57 "proto"
58 ],
59 "enumDescriptions": [
60 "Responses with Content-Type of application/json",
61 "Media download with context-dependent Content-Type",
62 "Responses with Content-Type of application/x-protobuf"
63 ],
64 "location": "query",
65 "type": "string"
66 },
67 "callback": {
68 "description": "JSONP",
69 "location": "query",
70 "type": "string"
71 },
72 "fields": {
73 "description": "Selector specifying which fields to include in a partial response.",
74 "location": "query",
75 "type": "string"
76 },
77 "key": {
78 "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.",
79 "location": "query",
80 "type": "string"
81 },
82 "oauth_token": {
83 "description": "OAuth 2.0 token for the current user.",
84 "location": "query",
85 "type": "string"
86 },
87 "prettyPrint": {
88 "default": "true",
89 "description": "Returns response with indentations and line breaks.",
90 "location": "query",
91 "type": "boolean"
92 },
93 "quotaUser": {
94 "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.",
95 "location": "query",
96 "type": "string"
97 },
98 "uploadType": {
99 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
100 "location": "query",
101 "type": "string"
102 },
103 "upload_protocol": {
104 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
105 "location": "query",
106 "type": "string"
107 }
108 },
109 "protocol": "rest",
110 "resources": {
111 "operations": {
112 "methods": {
113 "cancel": {
114 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
115 "flatPath": "v1/operations/{operationsId}:cancel",
116 "httpMethod": "POST",
117 "id": "firebasehosting.operations.cancel",
118 "parameterOrder": [
119 "name"
120 ],
121 "parameters": {
122 "name": {
123 "description": "The name of the operation resource to be cancelled.",
124 "location": "path",
125 "pattern": "^operations/.*$",
126 "required": true,
127 "type": "string"
128 }
129 },
130 "path": "v1/{+name}:cancel",
131 "request": {
132 "$ref": "CancelOperationRequest"
133 },
134 "response": {
135 "$ref": "Empty"
136 }
137 },
138 "delete": {
139 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
140 "flatPath": "v1/operations/{operationsId}",
141 "httpMethod": "DELETE",
142 "id": "firebasehosting.operations.delete",
143 "parameterOrder": [
144 "name"
145 ],
146 "parameters": {
147 "name": {
148 "description": "The name of the operation resource to be deleted.",
149 "location": "path",
150 "pattern": "^operations/.*$",
151 "required": true,
152 "type": "string"
153 }
154 },
155 "path": "v1/{+name}",
156 "response": {
157 "$ref": "Empty"
158 }
159 },
160 "list": {
161 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
162 "flatPath": "v1/operations",
163 "httpMethod": "GET",
164 "id": "firebasehosting.operations.list",
165 "parameterOrder": [
166 "name"
167 ],
168 "parameters": {
169 "filter": {
170 "description": "The standard list filter.",
171 "location": "query",
172 "type": "string"
173 },
174 "name": {
175 "description": "The name of the operation's parent resource.",
176 "location": "path",
177 "pattern": "^operations$",
178 "required": true,
179 "type": "string"
180 },
181 "pageSize": {
182 "description": "The standard list page size.",
183 "format": "int32",
184 "location": "query",
185 "type": "integer"
186 },
187 "pageToken": {
188 "description": "The standard list page token.",
189 "location": "query",
190 "type": "string"
191 }
192 },
193 "path": "v1/{+name}",
194 "response": {
195 "$ref": "ListOperationsResponse"
196 }
197 }
198 }
199 },
200 "projects": {
201 "resources": {
202 "sites": {
203 "resources": {
204 "customDomains": {
205 "resources": {
206 "operations": {
207 "methods": {
208 "cancel": {
209 "description": "CancelOperation is a part of the google.longrunning.Operations interface, but is not implemented for CustomDomain resources.",
210 "flatPath": "v1/projects/{projectsId}/sites/{sitesId}/customDomains/{customDomainsId}/operations/{operationsId}:cancel",
211 "httpMethod": "POST",
212 "id": "firebasehosting.projects.sites.customDomains.operations.cancel",
213 "parameterOrder": [
214 "name"
215 ],
216 "parameters": {
217 "name": {
218 "description": "The name of the operation resource to be cancelled.",
219 "location": "path",
220 "pattern": "^projects/[^/]+/sites/[^/]+/customDomains/[^/]+/operations/[^/]+$",
221 "required": true,
222 "type": "string"
223 }
224 },
225 "path": "v1/{+name}:cancel",
226 "request": {
227 "$ref": "CancelOperationRequest"
228 },
229 "response": {
230 "$ref": "Empty"
231 },
232 "scopes": [
233 "https://www.googleapis.com/auth/cloud-platform",
234 "https://www.googleapis.com/auth/firebase"
235 ]
236 },
237 "delete": {
238 "description": "DeleteOperation is a part of the google.longrunning.Operations interface, but is not implemented for CustomDomain resources.",
239 "flatPath": "v1/projects/{projectsId}/sites/{sitesId}/customDomains/{customDomainsId}/operations/{operationsId}",
240 "httpMethod": "DELETE",
241 "id": "firebasehosting.projects.sites.customDomains.operations.delete",
242 "parameterOrder": [
243 "name"
244 ],
245 "parameters": {
246 "name": {
247 "description": "The name of the operation resource to be deleted.",
248 "location": "path",
249 "pattern": "^projects/[^/]+/sites/[^/]+/customDomains/[^/]+/operations/[^/]+$",
250 "required": true,
251 "type": "string"
252 }
253 },
254 "path": "v1/{+name}",
255 "response": {
256 "$ref": "Empty"
257 },
258 "scopes": [
259 "https://www.googleapis.com/auth/cloud-platform",
260 "https://www.googleapis.com/auth/firebase"
261 ]
262 }
263 }
264 }
265 }
266 }
267 }
268 }
269 }
270 }
271 },
272 "revision": "20240319",
273 "rootUrl": "https://firebasehosting.googleapis.com/",
274 "schemas": {
275 "CancelOperationRequest": {
276 "description": "The request message for Operations.CancelOperation.",
277 "id": "CancelOperationRequest",
278 "properties": {},
279 "type": "object"
280 },
281 "CertVerification": {
282 "description": "A set of ACME challenges you can use to allow Hosting to create an SSL certificate for your domain name before directing traffic to Hosting servers. Use either the DNS or HTTP challenge; it's not necessary to provide both.",
283 "id": "CertVerification",
284 "properties": {
285 "dns": {
286 "$ref": "DnsUpdates",
287 "description": "Output only. A `TXT` record to add to your DNS records that confirms your intent to let Hosting create an SSL cert for your domain name.",
288 "readOnly": true
289 },
290 "http": {
291 "$ref": "HttpUpdate",
292 "description": "Output only. A file to add to your existing, non-Hosting hosting service that confirms your intent to let Hosting create an SSL cert for your domain name.",
293 "readOnly": true
294 }
295 },
296 "type": "object"
297 },
298 "CustomDomainMetadata": {
299 "description": "Metadata associated with a`CustomDomain` operation.",
300 "id": "CustomDomainMetadata",
301 "properties": {
302 "certState": {
303 "description": "The `CertState` of the domain name's SSL certificate.",
304 "enum": [
305 "CERT_STATE_UNSPECIFIED",
306 "CERT_PREPARING",
307 "CERT_VALIDATING",
308 "CERT_PROPAGATING",
309 "CERT_ACTIVE",
310 "CERT_EXPIRING_SOON",
311 "CERT_EXPIRED"
312 ],
313 "enumDescriptions": [
314 "The certificate's state is unspecified. The message is invalid if this is unspecified.",
315 "The initial state of every certificate, represents Hosting's intent to create a certificate, before requests to a Certificate Authority are made.",
316 "Hosting is validating whether a domain name's DNS records are in a state that allow certificate creation on its behalf.",
317 "The certificate was recently created, and needs time to propagate in Hosting's CDN.",
318 "The certificate is active, providing secure connections for the domain names it represents.",
319 "The certificate is expiring, all domain names on it will be given new certificates.",
320 "The certificate has expired. Hosting can no longer serve secure content on your domain name."
321 ],
322 "type": "string"
323 },
324 "hostState": {
325 "description": "The `HostState` of the domain name this `CustomDomain` refers to.",
326 "enum": [
327 "HOST_STATE_UNSPECIFIED",
328 "HOST_UNHOSTED",
329 "HOST_UNREACHABLE",
330 "HOST_MISMATCH",
331 "HOST_CONFLICT",
332 "HOST_ACTIVE"
333 ],
334 "enumDescriptions": [
335 "Your custom domain's host state is unspecified. The message is invalid if this is unspecified.",
336 "Your custom domain's domain name isn't associated with any IP addresses.",
337 "Your custom domain's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See your `CustomDomain` object's `issues` field for more details.",
338 "Your custom domain's domain name has IP addresses that don't ultimately resolve to Hosting.",
339 "Your custom domain's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, remove `A` and `AAAA` records related to non-Hosting services.",
340 "All requests against your custom domain's domain name are served by Hosting. If the custom domain's `OwnershipState` is also `ACTIVE`, Hosting serves your Hosting site's content on the domain name."
341 ],
342 "type": "string"
343 },
344 "issues": {
345 "description": "A list of issues that are currently preventing Hosting from completing the operation. These are generally DNS-related issues that Hosting encounters when querying a domain name's records or attempting to mint an SSL certificate.",
346 "items": {
347 "$ref": "Status"
348 },
349 "type": "array"
350 },
351 "liveMigrationSteps": {
352 "description": "A set of DNS record updates and ACME challenges that allow you to transition domain names to Firebase Hosting with zero downtime. These updates allow Hosting to create an SSL certificate and establish ownership for your custom domain before Hosting begins serving traffic on it. If your domain name is already in active use with another provider, add one of the challenges and make the recommended DNS updates. After adding challenges and adjusting DNS records as necessary, wait for the `ownershipState` to be `OWNERSHIP_ACTIVE` and the `certState` to be `CERT_ACTIVE` before sending traffic to Hosting.",
353 "items": {
354 "$ref": "LiveMigrationStep"
355 },
356 "type": "array"
357 },
358 "ownershipState": {
359 "description": "The `OwnershipState` of the domain name this `CustomDomain` refers to.",
360 "enum": [
361 "OWNERSHIP_STATE_UNSPECIFIED",
362 "OWNERSHIP_MISSING",
363 "OWNERSHIP_UNREACHABLE",
364 "OWNERSHIP_MISMATCH",
365 "OWNERSHIP_CONFLICT",
366 "OWNERSHIP_PENDING",
367 "OWNERSHIP_ACTIVE"
368 ],
369 "enumDescriptions": [
370 "Your custom domain's ownership state is unspecified. This should never happen.",
371 "Your custom domain's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf.",
372 "Your custom domain's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See your `CustomDomain` object's `issues` field for more details.",
373 "Your custom domain's domain name is owned by another Firebase project. Remove the conflicting `TXT` records and replace them with project-specific records for your current Firebase project.",
374 "Your custom domain's domain name has conflicting `TXT` records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership.",
375 "Your custom domain's DNS records are configured correctly. Hosting will transfer ownership of your domain to this `CustomDomain` within 24 hours.",
376 "Your custom domain's domain name has `TXT` records that grant its project permission to act on its behalf."
377 ],
378 "type": "string"
379 },
380 "quickSetupUpdates": {
381 "$ref": "DnsUpdates",
382 "description": "A set of DNS record updates that allow Hosting to serve secure content on your domain name. The record type determines the update's purpose: - `A` and `AAAA`: Updates your domain name's IP addresses so that they direct traffic to Hosting servers. - `TXT`: Updates ownership permissions on your domain name, letting Hosting know that your custom domain's project has permission to perform actions for that domain name. - `CAA`: Updates your domain name's list of authorized Certificate Authorities (CAs). Only present if you have existing `CAA` records that prohibit Hosting's CA from minting certs for your domain name. These updates include all DNS changes you'll need to get started with Hosting, but, if made all at once, can result in a brief period of downtime for your domain name--while Hosting creates and uploads an SSL cert, for example. If you'd like to add your domain name to Hosting without downtime, complete the `liveMigrationSteps` first, before making the remaining updates in this field."
383 }
384 },
385 "type": "object"
386 },
387 "DnsRecord": {
388 "description": "DNS records are resource records that define how systems and services should behave when handling requests for a domain name. For example, when you add `A` records to your domain name's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain name (such as your Hosting site files).",
389 "id": "DnsRecord",
390 "properties": {
391 "domainName": {
392 "description": "Output only. The domain name the record pertains to, e.g. `foo.bar.com.`.",
393 "readOnly": true,
394 "type": "string"
395 },
396 "rdata": {
397 "description": "Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain name. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine which Firebase projects have permission to act on the domain name's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue \"pki.goog\"`.",
398 "readOnly": true,
399 "type": "string"
400 },
401 "requiredAction": {
402 "description": "Output only. An enum that indicates the a required action for this record.",
403 "enum": [
404 "NONE",
405 "ADD",
406 "REMOVE"
407 ],
408 "enumDescriptions": [
409 "No action necessary.",
410 "Add this record to your DNS records.",
411 "Remove this record from your DNS records."
412 ],
413 "readOnly": true,
414 "type": "string"
415 },
416 "type": {
417 "description": "Output only. The record's type, which determines what data the record contains.",
418 "enum": [
419 "TYPE_UNSPECIFIED",
420 "A",
421 "CNAME",
422 "TXT",
423 "AAAA",
424 "CAA"
425 ],
426 "enumDescriptions": [
427 "The record's type is unspecified. The message is invalid if this is unspecified.",
428 "An `A` record, as defined in [RFC 1035](https://tools.ietf.org/html/rfc1035). A records determine which IPv4 addresses a domain name directs traffic towards.",
429 "A `CNAME` record, as defined in [RFC 1035](https://tools.ietf.org/html/rfc1035). `CNAME` or Canonical Name records map a domain name to a different, canonical domain name. If a `CNAME` record is present, it should be the only record on the domain name.",
430 "A `TXT` record, as defined in [RFC 1035](https://tools.ietf.org/html/rfc1035). `TXT` records hold arbitrary text data on a domain name. Hosting uses `TXT` records to establish which Firebase Project has permission to act on a domain name.",
431 "An AAAA record, as defined in [RFC 3596](https://tools.ietf.org/html/rfc3596) AAAA records determine which IPv6 addresses a domain name directs traffic towards.",
432 "A CAA record, as defined in [RFC 6844](https://tools.ietf.org/html/rfc6844). CAA, or Certificate Authority Authorization, records determine which Certificate Authorities (SSL certificate minting organizations) are authorized to mint a certificate for the domain name. Firebase Hosting uses `pki.goog` as its primary CA. CAA records cascade. A CAA record on `foo.com` also applies to `bar.foo.com` unless `bar.foo.com` has its own set of CAA records. CAA records are optional. If a domain name and its parents have no CAA records, all CAs are authorized to mint certificates on its behalf. In general, Hosting only asks you to modify CAA records when doing so is required to unblock SSL cert creation."
433 ],
434 "readOnly": true,
435 "type": "string"
436 }
437 },
438 "type": "object"
439 },
440 "DnsRecordSet": {
441 "description": "A set of DNS records relevant to the setup and maintenance of a custom domain in Firebase Hosting.",
442 "id": "DnsRecordSet",
443 "properties": {
444 "checkError": {
445 "$ref": "Status",
446 "description": "Output only. An error Hosting services encountered when querying your domain name's DNS records. Note: Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet.",
447 "readOnly": true
448 },
449 "domainName": {
450 "description": "Output only. The domain name the record set pertains to.",
451 "readOnly": true,
452 "type": "string"
453 },
454 "records": {
455 "description": "Output only. Records on the domain.",
456 "items": {
457 "$ref": "DnsRecord"
458 },
459 "readOnly": true,
460 "type": "array"
461 }
462 },
463 "type": "object"
464 },
465 "DnsUpdates": {
466 "description": "A set of DNS record updates that you should make to allow Hosting to serve secure content in response to requests against your domain name. These updates present the current state of your domain name's DNS records when Hosting last queried them, and the desired set of records that Hosting needs to see before your custom domain can be fully active.",
467 "id": "DnsUpdates",
468 "properties": {
469 "checkTime": {
470 "description": "The last time Hosting checked your custom domain's DNS records.",
471 "format": "google-datetime",
472 "type": "string"
473 },
474 "desired": {
475 "description": "The set of DNS records Hosting needs to serve secure content on the domain.",
476 "items": {
477 "$ref": "DnsRecordSet"
478 },
479 "type": "array"
480 },
481 "discovered": {
482 "description": "The set of DNS records Hosting discovered when inspecting a domain.",
483 "items": {
484 "$ref": "DnsRecordSet"
485 },
486 "type": "array"
487 }
488 },
489 "type": "object"
490 },
491 "Empty": {
492 "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); }",
493 "id": "Empty",
494 "properties": {},
495 "type": "object"
496 },
497 "HttpUpdate": {
498 "description": "A file you can add to your existing, non-Hosting hosting service that confirms your intent to allow Hosting's Certificate Authorities to create an SSL certificate for your domain.",
499 "id": "HttpUpdate",
500 "properties": {
501 "checkError": {
502 "$ref": "Status",
503 "description": "Output only. An error encountered during the last contents check. If null, the check completed successfully.",
504 "readOnly": true
505 },
506 "desired": {
507 "description": "Output only. A text string to serve at the path.",
508 "readOnly": true,
509 "type": "string"
510 },
511 "discovered": {
512 "description": "Output only. Whether Hosting was able to find the required file contents on the specified path during its last check.",
513 "readOnly": true,
514 "type": "string"
515 },
516 "lastCheckTime": {
517 "description": "Output only. The last time Hosting systems checked for the file contents.",
518 "format": "google-datetime",
519 "readOnly": true,
520 "type": "string"
521 },
522 "path": {
523 "description": "Output only. The path to the file.",
524 "readOnly": true,
525 "type": "string"
526 }
527 },
528 "type": "object"
529 },
530 "ListOperationsResponse": {
531 "description": "The response message for Operations.ListOperations.",
532 "id": "ListOperationsResponse",
533 "properties": {
534 "nextPageToken": {
535 "description": "The standard List next-page token.",
536 "type": "string"
537 },
538 "operations": {
539 "description": "A list of operations that matches the specified filter in the request.",
540 "items": {
541 "$ref": "Operation"
542 },
543 "type": "array"
544 }
545 },
546 "type": "object"
547 },
548 "LiveMigrationStep": {
549 "description": "A set of updates including ACME challenges and DNS records that allow Hosting to create an SSL certificate and establish project ownership for your domain name before you direct traffic to Hosting servers. Use these updates to facilitate zero downtime migrations to Hosting from other services. After you've made the recommended updates, check your custom domain's `ownershipState` and `certState`. To avoid downtime, they should be `OWNERSHIP_ACTIVE` and `CERT_ACTIVE`, respectively, before you update your `A` and `AAAA` records.",
550 "id": "LiveMigrationStep",
551 "properties": {
552 "certVerification": {
553 "$ref": "CertVerification",
554 "description": "Output only. A pair of ACME challenges that Hosting's Certificate Authority (CA) can use to create an SSL cert for your domain name. Use either the DNS or HTTP challenge; it's not necessary to provide both.",
555 "readOnly": true
556 },
557 "dnsUpdates": {
558 "$ref": "DnsUpdates",
559 "description": "Output only. DNS updates to facilitate your domain's zero-downtime migration to Hosting.",
560 "readOnly": true
561 },
562 "issues": {
563 "description": "Output only. Issues that prevent the current step from completing.",
564 "items": {
565 "$ref": "Status"
566 },
567 "readOnly": true,
568 "type": "array"
569 },
570 "state": {
571 "description": "Output only. The state of the live migration step, indicates whether you should work to complete the step now, in the future, or have already completed it.",
572 "enum": [
573 "STATE_UNSPECIFIED",
574 "PREPARING",
575 "PENDING",
576 "INCOMPLETE",
577 "PROCESSING",
578 "COMPLETE"
579 ],
580 "enumDescriptions": [
581 "The step's state is unspecified. The message is invalid if this is unspecified.",
582 "Hosting doesn't have enough information to construct the step yet. Complete any prior steps and/or resolve this step's issue to proceed.",
583 "The step's state is pending. Complete prior steps before working on a `PENDING` step.",
584 "The step is incomplete. You should complete any `certVerification` or `dnsUpdates` changes to complete it.",
585 "You've done your part to update records and present challenges as necessary. Hosting is now completing background processes to complete the step, e.g. minting an SSL cert for your domain name.",
586 "The step is complete. You've already made the necessary changes to your domain and/or prior hosting service to advance to the next step. Once all steps are complete, Hosting is ready to serve secure content on your domain."
587 ],
588 "readOnly": true,
589 "type": "string"
590 }
591 },
592 "type": "object"
593 },
594 "Operation": {
595 "description": "This resource represents a long-running operation that is the result of a network API call.",
596 "id": "Operation",
597 "properties": {
598 "done": {
599 "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.",
600 "type": "boolean"
601 },
602 "error": {
603 "$ref": "Status",
604 "description": "The error result of the operation in case of failure or cancellation."
605 },
606 "metadata": {
607 "additionalProperties": {
608 "description": "Properties of the object. Contains field @type with type URL.",
609 "type": "any"
610 },
611 "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.",
612 "type": "object"
613 },
614 "name": {
615 "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}`.",
616 "type": "string"
617 },
618 "response": {
619 "additionalProperties": {
620 "description": "Properties of the object. Contains field @type with type URL.",
621 "type": "any"
622 },
623 "description": "The normal, successful response of the operation. 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`.",
624 "type": "object"
625 }
626 },
627 "type": "object"
628 },
629 "Status": {
630 "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).",
631 "id": "Status",
632 "properties": {
633 "code": {
634 "description": "The status code, which should be an enum value of google.rpc.Code.",
635 "format": "int32",
636 "type": "integer"
637 },
638 "details": {
639 "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
640 "items": {
641 "additionalProperties": {
642 "description": "Properties of the object. Contains field @type with type URL.",
643 "type": "any"
644 },
645 "type": "object"
646 },
647 "type": "array"
648 },
649 "message": {
650 "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.",
651 "type": "string"
652 }
653 },
654 "type": "object"
655 }
656 },
657 "servicePath": "",
658 "title": "Firebase Hosting API",
659 "version": "v1",
660 "version_module": true
661}View as plain text