/
firestore-api.json
3346 lines (3346 loc) · 156 KB
/
firestore-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/datastore": {
"description": "View and manage your Google Cloud Datastore data"
}
}
}
},
"basePath": "",
"baseUrl": "https://firestore.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Firestore",
"description": "Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. ",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/firestore",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "firestore:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://firestore.mtls.googleapis.com/",
"name": "firestore",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"databases": {
"methods": {
"create": {
"description": "Create a database.",
"flatPath": "v1/projects/{projectsId}/databases",
"httpMethod": "POST",
"id": "firestore.projects.databases.create",
"parameterOrder": [
"parent"
],
"parameters": {
"databaseId": {
"description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database id is also valid.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. A parent name of the form `projects/{project_id}`",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/databases",
"request": {
"$ref": "GoogleFirestoreAdminV1Database"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"exportDocuments": {
"description": "Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}:exportDocuments",
"httpMethod": "POST",
"id": "firestore.projects.databases.exportDocuments",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:exportDocuments",
"request": {
"$ref": "GoogleFirestoreAdminV1ExportDocumentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"get": {
"description": "Gets information about a database.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}",
"httpMethod": "GET",
"id": "firestore.projects.databases.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. A name of the form `projects/{project_id}/databases/{database_id}`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleFirestoreAdminV1Database"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"importDocuments": {
"description": "Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}:importDocuments",
"httpMethod": "POST",
"id": "firestore.projects.databases.importDocuments",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:importDocuments",
"request": {
"$ref": "GoogleFirestoreAdminV1ImportDocumentsRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"list": {
"description": "List all the databases in the project.",
"flatPath": "v1/projects/{projectsId}/databases",
"httpMethod": "GET",
"id": "firestore.projects.databases.list",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. A parent name of the form `projects/{project_id}`",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/databases",
"response": {
"$ref": "GoogleFirestoreAdminV1ListDatabasesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"patch": {
"description": "Updates a database.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}",
"httpMethod": "PATCH",
"id": "firestore.projects.databases.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource name of the Database. Format: `projects/{project}/databases/{database}`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The list of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleFirestoreAdminV1Database"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
}
},
"resources": {
"collectionGroups": {
"resources": {
"fields": {
"methods": {
"get": {
"description": "Gets the metadata and configuration for a Field.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields/{fieldsId}",
"httpMethod": "GET",
"id": "firestore.projects.databases.collectionGroups.fields.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/fields/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleFirestoreAdminV1Field"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"list": {
"description": "Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false` .",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields",
"httpMethod": "GET",
"id": "firestore.projects.databases.collectionGroups.fields.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes `indexConfig.usesAncestorConfig:false` .",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The number of results to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/fields",
"response": {
"$ref": "GoogleFirestoreAdminV1ListFieldsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"patch": {
"description": "Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: \"index_config\" }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields/{fieldsId}",
"httpMethod": "PATCH",
"id": "firestore.projects.databases.collectionGroups.fields.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\\`address.city\\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\\`*\\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/fields/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "GoogleFirestoreAdminV1Field"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
}
}
},
"indexes": {
"methods": {
"create": {
"description": "Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes",
"httpMethod": "POST",
"id": "firestore.projects.databases.collectionGroups.indexes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/indexes",
"request": {
"$ref": "GoogleFirestoreAdminV1Index"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"delete": {
"description": "Deletes a composite index.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes/{indexesId}",
"httpMethod": "DELETE",
"id": "firestore.projects.databases.collectionGroups.indexes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/indexes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"get": {
"description": "Gets a composite index.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes/{indexesId}",
"httpMethod": "GET",
"id": "firestore.projects.databases.collectionGroups.indexes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+/indexes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleFirestoreAdminV1Index"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"list": {
"description": "Lists composite indexes.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes",
"httpMethod": "GET",
"id": "firestore.projects.databases.collectionGroups.indexes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter to apply to list results.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The number of results to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/collectionGroups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/indexes",
"response": {
"$ref": "GoogleFirestoreAdminV1ListIndexesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
}
}
}
}
},
"documents": {
"methods": {
"batchGet": {
"description": "Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents:batchGet",
"httpMethod": "POST",
"id": "firestore.projects.databases.documents.batchGet",
"parameterOrder": [
"database"
],
"parameters": {
"database": {
"description": "Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+database}/documents:batchGet",
"request": {
"$ref": "BatchGetDocumentsRequest"
},
"response": {
"$ref": "BatchGetDocumentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"batchWrite": {
"description": "Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents:batchWrite",
"httpMethod": "POST",
"id": "firestore.projects.databases.documents.batchWrite",
"parameterOrder": [
"database"
],
"parameters": {
"database": {
"description": "Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+database}/documents:batchWrite",
"request": {
"$ref": "BatchWriteRequest"
},
"response": {
"$ref": "BatchWriteResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"beginTransaction": {
"description": "Starts a new transaction.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction",
"httpMethod": "POST",
"id": "firestore.projects.databases.documents.beginTransaction",
"parameterOrder": [
"database"
],
"parameters": {
"database": {
"description": "Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+database}/documents:beginTransaction",
"request": {
"$ref": "BeginTransactionRequest"
},
"response": {
"$ref": "BeginTransactionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"commit": {
"description": "Commits a transaction, while optionally updating documents.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents:commit",
"httpMethod": "POST",
"id": "firestore.projects.databases.documents.commit",
"parameterOrder": [
"database"
],
"parameters": {
"database": {
"description": "Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+database}/documents:commit",
"request": {
"$ref": "CommitRequest"
},
"response": {
"$ref": "CommitResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"createDocument": {
"description": "Creates a new document.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}",
"httpMethod": "POST",
"id": "firestore.projects.databases.documents.createDocument",
"parameterOrder": [
"parent",
"collectionId"
],
"parameters": {
"collectionId": {
"description": "Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.",
"location": "path",
"required": true,
"type": "string"
},
"documentId": {
"description": "The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.",
"location": "query",
"type": "string"
},
"mask.fieldPaths": {
"description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.",
"location": "query",
"repeated": true,
"type": "string"
},
"parent": {
"description": "Required. The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/documents/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/{collectionId}",
"request": {
"$ref": "Document"
},
"response": {
"$ref": "Document"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"delete": {
"description": "Deletes a document.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
"httpMethod": "DELETE",
"id": "firestore.projects.databases.documents.delete",
"parameterOrder": [
"name"
],
"parameters": {
"currentDocument.exists": {
"description": "When set to `true`, the target document must exist. When set to `false`, the target document must not exist.",
"location": "query",
"type": "boolean"
},
"currentDocument.updateTime": {
"description": "When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"get": {
"description": "Gets a single document.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
"httpMethod": "GET",
"id": "firestore.projects.databases.documents.get",
"parameterOrder": [
"name"
],
"parameters": {
"mask.fieldPaths": {
"description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.",
"location": "query",
"repeated": true,
"type": "string"
},
"name": {
"description": "Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$",
"required": true,
"type": "string"
},
"readTime": {
"description": "Reads the version of the document at the given time. This may not be older than 270 seconds.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"transaction": {
"description": "Reads the document in a transaction.",
"format": "byte",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Document"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"list": {
"description": "Lists documents.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}",
"httpMethod": "GET",
"id": "firestore.projects.databases.documents.list",
"parameterOrder": [
"parent",
"collectionId"
],
"parameters": {
"collectionId": {
"description": "Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.",
"location": "path",
"required": true,
"type": "string"
},
"mask.fieldPaths": {
"description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.",
"location": "query",
"repeated": true,
"type": "string"
},
"orderBy": {
"description": "The order to sort results by. For example: `priority desc, name`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of documents to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The `next_page_token` value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$",
"required": true,
"type": "string"
},
"readTime": {
"description": "Reads documents as they were at the given time. This may not be older than 270 seconds.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"showMissing": {
"description": "If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with `show_missing` may not specify `where` or `order_by`.",
"location": "query",
"type": "boolean"
},
"transaction": {
"description": "Reads documents in a transaction.",
"format": "byte",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/{collectionId}",
"response": {
"$ref": "ListDocumentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"listCollectionIds": {
"description": "Lists all the collection IDs underneath a document.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:listCollectionIds",
"httpMethod": "POST",
"id": "firestore.projects.databases.documents.listCollectionIds",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:listCollectionIds",
"request": {
"$ref": "ListCollectionIdsRequest"
},
"response": {
"$ref": "ListCollectionIdsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"listDocuments": {
"description": "Lists documents.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents/{collectionId}",
"httpMethod": "GET",
"id": "firestore.projects.databases.documents.listDocuments",
"parameterOrder": [
"parent",
"collectionId"
],
"parameters": {
"collectionId": {
"description": "Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.",
"location": "path",
"required": true,
"type": "string"
},
"mask.fieldPaths": {
"description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.",
"location": "query",
"repeated": true,
"type": "string"
},
"orderBy": {
"description": "The order to sort results by. For example: `priority desc, name`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of documents to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The `next_page_token` value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/documents$",
"required": true,
"type": "string"
},
"readTime": {
"description": "Reads documents as they were at the given time. This may not be older than 270 seconds.",
"format": "google-datetime",
"location": "query",
"type": "string"
},
"showMissing": {
"description": "If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with `show_missing` may not specify `where` or `order_by`.",
"location": "query",
"type": "boolean"
},
"transaction": {
"description": "Reads documents in a transaction.",
"format": "byte",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/{collectionId}",
"response": {
"$ref": "ListDocumentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"listen": {
"description": "Listens to changes.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents:listen",
"httpMethod": "POST",
"id": "firestore.projects.databases.documents.listen",
"parameterOrder": [
"database"
],
"parameters": {
"database": {
"description": "Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+database}/documents:listen",
"request": {
"$ref": "ListenRequest"
},
"response": {
"$ref": "ListenResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"partitionQuery": {
"description": "Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.",
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:partitionQuery",
"httpMethod": "POST",
"id": "firestore.projects.databases.documents.partitionQuery",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents`. Document resource names are not supported; only database resource names can be specified.",
"location": "path",
"pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:partitionQuery",
"request": {