xref: /aosp_15_r20/external/googleapis/google/cloud/apigateway/v1/apigateway_v1.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9) 
1type: google.api.Service
2config_version: 3
3name: apigateway.googleapis.com
4title: API Gateway API
5
6apis:
7- name: google.cloud.apigateway.v1.ApiGatewayService
8
9types:
10- name: google.cloud.apigateway.v1.OperationMetadata
11
12documentation:
13  rules:
14  - selector: google.cloud.location.Locations.GetLocation
15    description: Gets information about a location.
16
17  - selector: google.cloud.location.Locations.ListLocations
18    description: Lists information about the supported locations for this service.
19
20  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
21    description: |-
22      Gets the access control policy for a resource. Returns an empty policy
23      if the resource exists and does not have a policy set.
24
25  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
26    description: |-
27      Sets the access control policy on the specified resource. Replaces
28      any existing policy.
29
30      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
31      errors.
32
33  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
34    description: |-
35      Returns permissions that a caller has on the specified resource. If the
36      resource does not exist, this will return an empty set of
37      permissions, not a `NOT_FOUND` error.
38
39      Note: This operation is designed to be used for building
40      permission-aware UIs and command-line tools, not for authorization
41      checking. This operation may "fail open" without warning.
42
43backend:
44  rules:
45  - selector: 'google.cloud.apigateway.v1.ApiGatewayService.*'
46    deadline: 60.0
47  - selector: google.cloud.location.Locations.GetLocation
48    deadline: 60.0
49  - selector: google.cloud.location.Locations.ListLocations
50    deadline: 60.0
51  - selector: 'google.iam.v1.IAMPolicy.*'
52    deadline: 60.0
53  - selector: 'google.longrunning.Operations.*'
54    deadline: 60.0
55  - selector: google.longrunning.Operations.GetOperation
56    deadline: 5.0
57
58http:
59  rules:
60  - selector: google.cloud.location.Locations.GetLocation
61    get: '/v1/{name=projects/*/locations/*}'
62  - selector: google.cloud.location.Locations.ListLocations
63    get: '/v1/{name=projects/*}/locations'
64  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
65    get: '/v1/{resource=projects/*/locations/*/gateways/*}:getIamPolicy'
66    additional_bindings:
67    - get: '/v1/{resource=projects/*/locations/*/apis/*}:getIamPolicy'
68    - get: '/v1/{resource=projects/*/locations/*/apis/*/configs/*}:getIamPolicy'
69  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
70    post: '/v1/{resource=projects/*/locations/*/gateways/*}:setIamPolicy'
71    body: '*'
72    additional_bindings:
73    - post: '/v1/{resource=projects/*/locations/*/apis/*}:setIamPolicy'
74      body: '*'
75    - post: '/v1/{resource=projects/*/locations/*/apis/*/configs/*}:setIamPolicy'
76      body: '*'
77  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
78    post: '/v1/{resource=projects/*/locations/*/gateways/*}:testIamPermissions'
79    body: '*'
80    additional_bindings:
81    - post: '/v1/{resource=projects/*/locations/*/apis/*}:testIamPermissions'
82      body: '*'
83    - post: '/v1/{resource=projects/*/locations/*/apis/*/configs/*}:testIamPermissions'
84      body: '*'
85  - selector: google.longrunning.Operations.CancelOperation
86    post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
87    body: '*'
88  - selector: google.longrunning.Operations.DeleteOperation
89    delete: '/v1/{name=projects/*/locations/*/operations/*}'
90  - selector: google.longrunning.Operations.GetOperation
91    get: '/v1/{name=projects/*/locations/*/operations/*}'
92  - selector: google.longrunning.Operations.ListOperations
93    get: '/v1/{name=projects/*/locations/*}/operations'
94
95authentication:
96  rules:
97  - selector: 'google.cloud.apigateway.v1.ApiGatewayService.*'
98    oauth:
99      canonical_scopes: |-
100        https://www.googleapis.com/auth/cloud-platform
101  - selector: google.cloud.location.Locations.GetLocation
102    oauth:
103      canonical_scopes: |-
104        https://www.googleapis.com/auth/cloud-platform
105  - selector: google.cloud.location.Locations.ListLocations
106    oauth:
107      canonical_scopes: |-
108        https://www.googleapis.com/auth/cloud-platform
109  - selector: 'google.iam.v1.IAMPolicy.*'
110    oauth:
111      canonical_scopes: |-
112        https://www.googleapis.com/auth/cloud-platform
113  - selector: 'google.longrunning.Operations.*'
114    oauth:
115      canonical_scopes: |-
116        https://www.googleapis.com/auth/cloud-platform
117