OLD | NEW |
1 { | 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform": { |
| 6 "description": "View and manage your data across Google Clou
d Platform services" |
| 7 } |
| 8 } |
| 9 } |
| 10 }, |
2 "basePath": "", | 11 "basePath": "", |
3 "baseUrl": "https://cloudfunctions.googleapis.com/", | 12 "baseUrl": "https://cloudfunctions.googleapis.com/", |
4 "batchPath": "batch", | 13 "batchPath": "batch", |
5 "canonicalName": "Cloud Functions", | 14 "canonicalName": "Cloud Functions", |
6 "description": "API for managing lightweight user-provided functions execute
d in response to events.", | 15 "description": "API for managing lightweight user-provided functions execute
d in response to events.", |
7 "discoveryVersion": "v1", | 16 "discoveryVersion": "v1", |
8 "documentationLink": "https://cloud.google.com/functions", | 17 "documentationLink": "https://cloud.google.com/functions", |
9 "icons": { | 18 "icons": { |
10 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
11 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
12 }, | 21 }, |
13 "id": "cloudfunctions:v1", | 22 "id": "cloudfunctions:v1", |
14 "kind": "discovery#restDescription", | 23 "kind": "discovery#restDescription", |
15 "name": "cloudfunctions", | 24 "name": "cloudfunctions", |
16 "ownerDomain": "google.com", | 25 "ownerDomain": "google.com", |
17 "ownerName": "Google", | 26 "ownerName": "Google", |
18 "parameters": { | 27 "parameters": { |
19 "fields": { | 28 "upload_protocol": { |
20 "description": "Selector specifying which fields to include in a par
tial response.", | 29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
21 "location": "query", | 30 "location": "query", |
22 "type": "string" | 31 "type": "string" |
23 }, | 32 }, |
| 33 "prettyPrint": { |
| 34 "default": "true", |
| 35 "description": "Returns response with indentations and line breaks."
, |
| 36 "location": "query", |
| 37 "type": "boolean" |
| 38 }, |
24 "uploadType": { | 39 "uploadType": { |
25 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 40 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
26 "location": "query", | 41 "location": "query", |
27 "type": "string" | 42 "type": "string" |
28 }, | 43 }, |
| 44 "fields": { |
| 45 "description": "Selector specifying which fields to include in a par
tial response.", |
| 46 "location": "query", |
| 47 "type": "string" |
| 48 }, |
29 "callback": { | 49 "callback": { |
30 "description": "JSONP", | 50 "description": "JSONP", |
31 "location": "query", | 51 "location": "query", |
32 "type": "string" | 52 "type": "string" |
33 }, | 53 }, |
34 "$.xgafv": { | 54 "$.xgafv": { |
35 "description": "V1 error format.", | 55 "description": "V1 error format.", |
36 "enum": [ | 56 "enum": [ |
37 "1", | 57 "1", |
38 "2" | 58 "2" |
(...skipping 14 matching lines...) Expand all Loading... |
53 "proto" | 73 "proto" |
54 ], | 74 ], |
55 "enumDescriptions": [ | 75 "enumDescriptions": [ |
56 "Responses with Content-Type of application/json", | 76 "Responses with Content-Type of application/json", |
57 "Media download with context-dependent Content-Type", | 77 "Media download with context-dependent Content-Type", |
58 "Responses with Content-Type of application/x-protobuf" | 78 "Responses with Content-Type of application/x-protobuf" |
59 ], | 79 ], |
60 "location": "query", | 80 "location": "query", |
61 "type": "string" | 81 "type": "string" |
62 }, | 82 }, |
| 83 "key": { |
| 84 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 85 "location": "query", |
| 86 "type": "string" |
| 87 }, |
63 "access_token": { | 88 "access_token": { |
64 "description": "OAuth access token.", | 89 "description": "OAuth access token.", |
65 "location": "query", | 90 "location": "query", |
66 "type": "string" | 91 "type": "string" |
67 }, | 92 }, |
68 "key": { | |
69 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
70 "location": "query", | |
71 "type": "string" | |
72 }, | |
73 "quotaUser": { | 93 "quotaUser": { |
74 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 94 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
75 "location": "query", | 95 "location": "query", |
76 "type": "string" | 96 "type": "string" |
77 }, | 97 }, |
78 "pp": { | 98 "pp": { |
79 "default": "true", | 99 "default": "true", |
80 "description": "Pretty-print response.", | 100 "description": "Pretty-print response.", |
81 "location": "query", | 101 "location": "query", |
82 "type": "boolean" | 102 "type": "boolean" |
83 }, | 103 }, |
84 "oauth_token": { | 104 "oauth_token": { |
85 "description": "OAuth 2.0 token for the current user.", | 105 "description": "OAuth 2.0 token for the current user.", |
86 "location": "query", | 106 "location": "query", |
87 "type": "string" | 107 "type": "string" |
88 }, | 108 }, |
89 "bearer_token": { | 109 "bearer_token": { |
90 "description": "OAuth bearer token.", | 110 "description": "OAuth bearer token.", |
91 "location": "query", | 111 "location": "query", |
92 "type": "string" | 112 "type": "string" |
93 }, | |
94 "upload_protocol": { | |
95 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
96 "location": "query", | |
97 "type": "string" | |
98 }, | |
99 "prettyPrint": { | |
100 "default": "true", | |
101 "description": "Returns response with indentations and line breaks."
, | |
102 "location": "query", | |
103 "type": "boolean" | |
104 } | 113 } |
105 }, | 114 }, |
106 "protocol": "rest", | 115 "protocol": "rest", |
107 "resources": {}, | 116 "resources": { |
108 "revision": "20170704", | 117 "projects": { |
| 118 "resources": { |
| 119 "locations": { |
| 120 "methods": { |
| 121 "list": { |
| 122 "description": "Lists information about the supporte
d locations for this service.", |
| 123 "httpMethod": "GET", |
| 124 "id": "cloudfunctions.projects.locations.list", |
| 125 "parameterOrder": [ |
| 126 "name" |
| 127 ], |
| 128 "parameters": { |
| 129 "filter": { |
| 130 "description": "The standard list filter.", |
| 131 "location": "query", |
| 132 "type": "string" |
| 133 }, |
| 134 "pageToken": { |
| 135 "description": "The standard list page token
.", |
| 136 "location": "query", |
| 137 "type": "string" |
| 138 }, |
| 139 "name": { |
| 140 "description": "The resource that owns the l
ocations collection, if applicable.", |
| 141 "location": "path", |
| 142 "pattern": "^projects/[^/]+$", |
| 143 "required": true, |
| 144 "type": "string" |
| 145 }, |
| 146 "pageSize": { |
| 147 "description": "The standard list page size.
", |
| 148 "format": "int32", |
| 149 "location": "query", |
| 150 "type": "integer" |
| 151 } |
| 152 }, |
| 153 "path": "v1/{+name}/locations", |
| 154 "response": { |
| 155 "$ref": "ListLocationsResponse" |
| 156 }, |
| 157 "scopes": [ |
| 158 "https://www.googleapis.com/auth/cloud-platform" |
| 159 ] |
| 160 } |
| 161 } |
| 162 } |
| 163 } |
| 164 }, |
| 165 "operations": { |
| 166 "methods": { |
| 167 "get": { |
| 168 "description": "Gets the latest state of a long-running oper
ation. Clients can use this\nmethod to poll the operation result at intervals a
s recommended by the API\nservice.", |
| 169 "httpMethod": "GET", |
| 170 "id": "cloudfunctions.operations.get", |
| 171 "parameterOrder": [ |
| 172 "name" |
| 173 ], |
| 174 "parameters": { |
| 175 "name": { |
| 176 "description": "The name of the operation resource."
, |
| 177 "location": "path", |
| 178 "pattern": "^operations/[^/]+$", |
| 179 "required": true, |
| 180 "type": "string" |
| 181 } |
| 182 }, |
| 183 "path": "v1/{+name}", |
| 184 "response": { |
| 185 "$ref": "Operation" |
| 186 }, |
| 187 "scopes": [ |
| 188 "https://www.googleapis.com/auth/cloud-platform" |
| 189 ] |
| 190 }, |
| 191 "list": { |
| 192 "description": "Lists operations that match the specified fi
lter in the request. If the\nserver doesn't support this method, it returns `UNI
MPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the bin
ding\nto use different resource name schemes, such as `users/*/operations`. To\n
override the binding, API services can add a binding such as\n`\"/v1/{name=users
/*}/operations\"` to their service configuration.\nFor backwards compatibility,
the default name includes the operations\ncollection id, however overriding user
s must ensure the name binding\nis the parent resource, without the operations c
ollection id.", |
| 193 "httpMethod": "GET", |
| 194 "id": "cloudfunctions.operations.list", |
| 195 "parameterOrder": [], |
| 196 "parameters": { |
| 197 "pageToken": { |
| 198 "description": "The standard list page token.", |
| 199 "location": "query", |
| 200 "type": "string" |
| 201 }, |
| 202 "name": { |
| 203 "description": "The name of the operation's parent r
esource.", |
| 204 "location": "query", |
| 205 "type": "string" |
| 206 }, |
| 207 "pageSize": { |
| 208 "description": "The standard list page size.", |
| 209 "format": "int32", |
| 210 "location": "query", |
| 211 "type": "integer" |
| 212 }, |
| 213 "filter": { |
| 214 "description": "The standard list filter.", |
| 215 "location": "query", |
| 216 "type": "string" |
| 217 } |
| 218 }, |
| 219 "path": "v1/operations", |
| 220 "response": { |
| 221 "$ref": "ListOperationsResponse" |
| 222 }, |
| 223 "scopes": [ |
| 224 "https://www.googleapis.com/auth/cloud-platform" |
| 225 ] |
| 226 } |
| 227 } |
| 228 } |
| 229 }, |
| 230 "revision": "20170726", |
109 "rootUrl": "https://cloudfunctions.googleapis.com/", | 231 "rootUrl": "https://cloudfunctions.googleapis.com/", |
110 "schemas": { | 232 "schemas": { |
111 "OperationMetadataV1Beta2": { | 233 "OperationMetadataV1Beta2": { |
112 "description": "Metadata describing an Operation", | 234 "description": "Metadata describing an Operation", |
113 "id": "OperationMetadataV1Beta2", | 235 "id": "OperationMetadataV1Beta2", |
114 "properties": { | 236 "properties": { |
115 "target": { | 237 "target": { |
116 "description": "Target of the operation - for example\nproje
cts/project-1/locations/region-1/functions/function-1", | 238 "description": "Target of the operation - for example\nproje
cts/project-1/locations/region-1/functions/function-1", |
117 "type": "string" | 239 "type": "string" |
118 }, | 240 }, |
(...skipping 16 matching lines...) Expand all Loading... |
135 "enumDescriptions": [ | 257 "enumDescriptions": [ |
136 "Unknown operation type.", | 258 "Unknown operation type.", |
137 "Triggered by CreateFunction call", | 259 "Triggered by CreateFunction call", |
138 "Triggered by UpdateFunction call", | 260 "Triggered by UpdateFunction call", |
139 "Triggered by DeleteFunction call." | 261 "Triggered by DeleteFunction call." |
140 ], | 262 ], |
141 "type": "string" | 263 "type": "string" |
142 } | 264 } |
143 }, | 265 }, |
144 "type": "object" | 266 "type": "object" |
| 267 }, |
| 268 "Status": { |
| 269 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", |
| 270 "id": "Status", |
| 271 "properties": { |
| 272 "message": { |
| 273 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
| 274 "type": "string" |
| 275 }, |
| 276 "details": { |
| 277 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", |
| 278 "items": { |
| 279 "additionalProperties": { |
| 280 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 281 "type": "any" |
| 282 }, |
| 283 "type": "object" |
| 284 }, |
| 285 "type": "array" |
| 286 }, |
| 287 "code": { |
| 288 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 289 "format": "int32", |
| 290 "type": "integer" |
| 291 } |
| 292 }, |
| 293 "type": "object" |
| 294 }, |
| 295 "ListLocationsResponse": { |
| 296 "description": "The response message for Locations.ListLocations.", |
| 297 "id": "ListLocationsResponse", |
| 298 "properties": { |
| 299 "nextPageToken": { |
| 300 "description": "The standard List next-page token.", |
| 301 "type": "string" |
| 302 }, |
| 303 "locations": { |
| 304 "description": "A list of locations that matches the specifi
ed filter in the request.", |
| 305 "items": { |
| 306 "$ref": "Location" |
| 307 }, |
| 308 "type": "array" |
| 309 } |
| 310 }, |
| 311 "type": "object" |
| 312 }, |
| 313 "Location": { |
| 314 "description": "A resource that represents Google Cloud Platform loc
ation.", |
| 315 "id": "Location", |
| 316 "properties": { |
| 317 "labels": { |
| 318 "additionalProperties": { |
| 319 "type": "string" |
| 320 }, |
| 321 "description": "Cross-service attributes for the location. F
or example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", |
| 322 "type": "object" |
| 323 }, |
| 324 "name": { |
| 325 "description": "Resource name for the location, which may va
ry between implementations.\nFor example: `\"projects/example-project/locations/
us-east1\"`", |
| 326 "type": "string" |
| 327 }, |
| 328 "locationId": { |
| 329 "description": "The canonical id for this location. For exam
ple: `\"us-east1\"`.", |
| 330 "type": "string" |
| 331 }, |
| 332 "metadata": { |
| 333 "additionalProperties": { |
| 334 "description": "Properties of the object. Contains field
@type with type URL.", |
| 335 "type": "any" |
| 336 }, |
| 337 "description": "Service-specific metadata. For example the a
vailable capacity at the given\nlocation.", |
| 338 "type": "object" |
| 339 } |
| 340 }, |
| 341 "type": "object" |
| 342 }, |
| 343 "ListOperationsResponse": { |
| 344 "description": "The response message for Operations.ListOperations."
, |
| 345 "id": "ListOperationsResponse", |
| 346 "properties": { |
| 347 "nextPageToken": { |
| 348 "description": "The standard List next-page token.", |
| 349 "type": "string" |
| 350 }, |
| 351 "operations": { |
| 352 "description": "A list of operations that matches the specif
ied filter in the request.", |
| 353 "items": { |
| 354 "$ref": "Operation" |
| 355 }, |
| 356 "type": "array" |
| 357 } |
| 358 }, |
| 359 "type": "object" |
| 360 }, |
| 361 "Operation": { |
| 362 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
| 363 "id": "Operation", |
| 364 "properties": { |
| 365 "done": { |
| 366 "description": "If the value is `false`, it means the operat
ion is still in progress.\nIf true, the operation is completed, and either `erro
r` or `response` is\navailable.", |
| 367 "type": "boolean" |
| 368 }, |
| 369 "response": { |
| 370 "additionalProperties": { |
| 371 "description": "Properties of the object. Contains field
@type with type URL.", |
| 372 "type": "any" |
| 373 }, |
| 374 "description": "The normal response of the operation in case
of success. If the original\nmethod returns no data on success, such as `Delet
e`, the response is\n`google.protobuf.Empty`. If the original method is standar
d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet
hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi
nal method name. For example, if the original method name\nis `TakeSnapshot()`,
the inferred response type is\n`TakeSnapshotResponse`.", |
| 375 "type": "object" |
| 376 }, |
| 377 "name": { |
| 378 "description": "The server-assigned name, which is only uniq
ue within the same service that\noriginally returns it. If you use the default H
TTP mapping, the\n`name` should have the format of `operations/some/unique/name`
.", |
| 379 "type": "string" |
| 380 }, |
| 381 "error": { |
| 382 "$ref": "Status", |
| 383 "description": "The error result of the operation in case of
failure or cancellation." |
| 384 }, |
| 385 "metadata": { |
| 386 "additionalProperties": { |
| 387 "description": "Properties of the object. Contains field
@type with type URL.", |
| 388 "type": "any" |
| 389 }, |
| 390 "description": "Service-specific metadata associated with th
e operation. It typically\ncontains progress information and common metadata su
ch as create time.\nSome services might not provide such metadata. Any method t
hat returns a\nlong-running operation should document the metadata type, if any.
", |
| 391 "type": "object" |
| 392 } |
| 393 }, |
| 394 "type": "object" |
145 } | 395 } |
146 }, | 396 }, |
147 "servicePath": "", | 397 "servicePath": "", |
148 "title": "Google Cloud Functions API", | 398 "title": "Google Cloud Functions API", |
149 "version": "v1" | 399 "version": "v1" |
150 } | 400 } |
OLD | NEW |