xref: /aosp_15_r20/external/googleapis/google/firestore/v1/firestore_v1.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
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.v1.Firestore
9- name: google.longrunning.Operations
10
11documentation:
12  summary: |-
13    Accesses the NoSQL document database built for automatic scaling, high
14    performance, and ease of application development.
15  rules:
16  - selector: google.cloud.location.Locations.GetLocation
17    description: Gets information about a location.
18
19  - selector: google.cloud.location.Locations.ListLocations
20    description: Lists information about the supported locations for this service.
21
22http:
23  rules:
24  - selector: google.longrunning.Operations.CancelOperation
25    post: '/v1/{name=projects/*/databases/*/operations/*}:cancel'
26    body: '*'
27  - selector: google.longrunning.Operations.DeleteOperation
28    delete: '/v1/{name=projects/*/databases/*/operations/*}'
29  - selector: google.longrunning.Operations.GetOperation
30    get: '/v1/{name=projects/*/databases/*/operations/*}'
31  - selector: google.longrunning.Operations.ListOperations
32    get: '/v1/{name=projects/*/databases/*}/operations'
33
34authentication:
35  rules:
36  - selector: google.cloud.location.Locations.GetLocation
37    oauth:
38      canonical_scopes: |-
39        https://www.googleapis.com/auth/cloud-platform,
40        https://www.googleapis.com/auth/datastore
41  - selector: google.cloud.location.Locations.ListLocations
42    oauth:
43      canonical_scopes: |-
44        https://www.googleapis.com/auth/cloud-platform,
45        https://www.googleapis.com/auth/datastore
46  - selector: 'google.firestore.v1.Firestore.*'
47    oauth:
48      canonical_scopes: |-
49        https://www.googleapis.com/auth/cloud-platform,
50        https://www.googleapis.com/auth/datastore
51  - selector: 'google.longrunning.Operations.*'
52    oauth:
53      canonical_scopes: |-
54        https://www.googleapis.com/auth/cloud-platform,
55        https://www.googleapis.com/auth/datastore
56