• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1type: google.api.Service
2config_version: 3
3name: firestore.googleapis.com
4title: Cloud Firestore API
5
6apis:
7- name: google.cloud.location.Locations
8- name: google.firestore.admin.v1.FirestoreAdmin
9- name: google.longrunning.Operations
10
11types:
12- name: google.firestore.admin.v1.CreateDatabaseMetadata
13- name: google.firestore.admin.v1.DeleteDatabaseMetadata
14- name: google.firestore.admin.v1.ExportDocumentsMetadata
15- name: google.firestore.admin.v1.ExportDocumentsResponse
16- name: google.firestore.admin.v1.FieldOperationMetadata
17- name: google.firestore.admin.v1.ImportDocumentsMetadata
18- name: google.firestore.admin.v1.IndexOperationMetadata
19- name: google.firestore.admin.v1.LocationMetadata
20- name: google.firestore.admin.v1.RestoreDatabaseMetadata
21- name: google.firestore.admin.v1.UpdateDatabaseMetadata
22
23documentation:
24  summary: |-
25    Accesses the NoSQL document database built for automatic scaling, high
26    performance, and ease of application development.
27  rules:
28  - selector: google.cloud.location.Locations.GetLocation
29    description: Gets information about a location.
30
31  - selector: google.cloud.location.Locations.ListLocations
32    description: Lists information about the supported locations for this service.
33
34backend:
35  rules:
36  - selector: google.cloud.location.Locations.GetLocation
37    deadline: 295.0
38  - selector: google.cloud.location.Locations.ListLocations
39    deadline: 295.0
40  - selector: 'google.firestore.admin.v1.FirestoreAdmin.*'
41    deadline: 295.0
42  - selector: 'google.longrunning.Operations.*'
43    deadline: 295.0
44
45http:
46  rules:
47  - selector: google.longrunning.Operations.CancelOperation
48    post: '/v1/{name=projects/*/databases/*/operations/*}:cancel'
49    body: '*'
50  - selector: google.longrunning.Operations.DeleteOperation
51    delete: '/v1/{name=projects/*/databases/*/operations/*}'
52  - selector: google.longrunning.Operations.GetOperation
53    get: '/v1/{name=projects/*/databases/*/operations/*}'
54  - selector: google.longrunning.Operations.ListOperations
55    get: '/v1/{name=projects/*/databases/*}/operations'
56
57authentication:
58  rules:
59  - selector: google.cloud.location.Locations.GetLocation
60    oauth:
61      canonical_scopes: |-
62        https://www.googleapis.com/auth/cloud-platform,
63        https://www.googleapis.com/auth/datastore
64  - selector: google.cloud.location.Locations.ListLocations
65    oauth:
66      canonical_scopes: |-
67        https://www.googleapis.com/auth/cloud-platform,
68        https://www.googleapis.com/auth/datastore
69  - selector: 'google.firestore.admin.v1.FirestoreAdmin.*'
70    oauth:
71      canonical_scopes: |-
72        https://www.googleapis.com/auth/cloud-platform,
73        https://www.googleapis.com/auth/datastore
74  - selector: 'google.longrunning.Operations.*'
75    oauth:
76      canonical_scopes: |-
77        https://www.googleapis.com/auth/cloud-platform,
78        https://www.googleapis.com/auth/datastore
79