blob: 2cf40daa0cda71dcf5214487dfd713fec3492201 [file] [log] [blame]
{
"ownerDomain": "google.com",
"name": "cloudfunctions",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Functions API",
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"list": {
"response": {
"$ref": "ListLocationsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"filter": {
"description": "The standard list filter.",
"type": "string",
"location": "query"
},
"pageToken": {
"description": "The standard list page token.",
"type": "string",
"location": "query"
},
"name": {
"location": "path",
"description": "The resource that owns the locations collection, if applicable.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "The standard list page size.",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations",
"id": "cloudfunctions.projects.locations.list",
"path": "v1/{+name}/locations",
"description": "Lists information about the supported locations for this service."
}
}
}
}
},
"operations": {
"methods": {
"get": {
"httpMethod": "GET",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"type": "string",
"required": true,
"pattern": "^operations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/operations/{operationsId}",
"path": "v1/{+name}",
"id": "cloudfunctions.operations.get",
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
},
"list": {
"path": "v1/operations",
"id": "cloudfunctions.operations.list",
"description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride 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 users must ensure the name binding\nis the parent resource, without the operations collection id.",
"httpMethod": "GET",
"parameterOrder": [],
"response": {
"$ref": "ListOperationsResponse"
},
"parameters": {
"filter": {
"location": "query",
"description": "The standard list filter.",
"type": "string"
},
"pageToken": {
"location": "query",
"description": "The standard list page token.",
"type": "string"
},
"name": {
"location": "query",
"description": "The name of the operation's parent resource.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "The standard list page size.",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/operations"
}
}
}
},
"parameters": {
"quotaUser": {
"type": "string",
"location": "query",
"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."
},
"pp": {
"location": "query",
"description": "Pretty-print response.",
"default": "true",
"type": "boolean"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"upload_protocol": {
"type": "string",
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"prettyPrint": {
"default": "true",
"type": "boolean",
"location": "query",
"description": "Returns response with indentations and line breaks."
},
"uploadType": {
"type": "string",
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"$.xgafv": {
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
]
},
"alt": {
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"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",
"description": "Data format for response.",
"default": "json"
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
"key": {
"location": "query",
"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.",
"type": "string"
}
},
"version": "v1",
"baseUrl": "https://cloudfunctions.googleapis.com/",
"servicePath": "",
"kind": "discovery#restDescription",
"description": "API for managing lightweight user-provided functions executed in response to events.",
"basePath": "",
"id": "cloudfunctions:v1",
"documentationLink": "https://cloud.google.com/functions",
"revision": "20171009",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"OperationMetadataV1Beta2": {
"description": "Metadata describing an Operation",
"type": "object",
"properties": {
"target": {
"description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
"type": "string"
},
"versionId": {
"type": "string",
"format": "int64",
"description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations."
},
"request": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The original request that started the operation."
},
"type": {
"description": "Type of operation.",
"type": "string",
"enumDescriptions": [
"Unknown operation type.",
"Triggered by CreateFunction call",
"Triggered by UpdateFunction call",
"Triggered by DeleteFunction call."
],
"enum": [
"OPERATION_UNSPECIFIED",
"CREATE_FUNCTION",
"UPDATE_FUNCTION",
"DELETE_FUNCTION"
]
}
},
"id": "OperationMetadataV1Beta2"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should 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 that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\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\ninformation 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# Language 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` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\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\nenvironments, 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 may\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 results 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 stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"type": "object"
},
"type": "array"
},
"code": {
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
},
"message": {
"description": "A developer-facing error message, which should 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.",
"type": "string"
}
},
"id": "Status"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
"nextPageToken": {
"type": "string",
"description": "The standard List next-page token."
},
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
}
},
"id": "ListLocationsResponse"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}"
},
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"id": "Location"
},
"ListOperationsResponse": {
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"id": "ListOperationsResponse",
"description": "The response message for Operations.ListOperations.",
"type": "object"
},
"Operation": {
"type": "object",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"response": {
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
}
},
"id": "Operation",
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
}
},
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "Cloud Functions",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://cloudfunctions.googleapis.com/"
}