OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(json): updated API descriptions

Browse Source
This commit is contained in:
Sebastian Thiel
2016-01-30 14:05:22 +01:00
parent a2c6b58d5b
commit 8f01e8e918
145 changed files with 50073 additions and 3975 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
etc/api/appengine/v1beta4/appengine-api.json
View File

@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
"etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/MxcrsWLtc_45Vl0dvlLXLZx13VM\"",
"etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/q1k107w8H1_Vpbv_soyd95U2Uhs\"",
"discoveryVersion": "v1",
"id": "appengine:v1beta4",
"name": "appengine",
"version": "v1beta4",
"revision": "20150831",
"revision": "20160121",
"title": "Google App Engine Admin API",
"description": "The Google App Engine Admin API enables developers to provision and manage their App Engine applications.",
"ownerDomain": "google.com",
@@ -14,10 +14,10 @@
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"documentationLink": "https://developers.google.com/appengine/",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"protocol": "rest",
"baseUrl": "https://appengine.googleapis.com/",
"basePath": "/",
"basePath": "",
"rootUrl": "https://appengine.googleapis.com/",
"servicePath": "",
"batchPath": "batch",
@@ -137,6 +137,10 @@
"codeBucket": {
"type": "string",
"description": "A Google Cloud Storage bucket which can be used for storing files associated with an application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly"
},
"defaultBucket": {
"type": "string",
"description": "A Google Cloud Storage bucket which can be used by the application to store content. @OutputOnly"
}
}
},
@@ -235,7 +239,7 @@
},
"vm": {
"type": "boolean",
"description": "Whether to deploy this app in a VM container (deprecated, use \"env\":\"2\")."
"description": "Whether to deploy this app in a VM container."
},
"betaSettings": {
"type": "object",
@@ -360,6 +364,18 @@
"minPendingLatency": {
"type": "string",
"description": "The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it."
},
"requestUtilization": {
"$ref": "RequestUtilization",
"description": "Target scaling by request utilization."
},
"diskUtilization": {
"$ref": "DiskUtilization",
"description": "Target scaling by disk usage."
},
"networkUtilization": {
"$ref": "NetworkUtilization",
"description": "Target scaling by network usage."
}
}
},
@@ -379,6 +395,77 @@
}
}
},
"RequestUtilization": {
"id": "RequestUtilization",
"type": "object",
"description": "Target scaling by request utilization (for VM runtimes only).",
"properties": {
"targetRequestCountPerSec": {
"type": "integer",
"description": "Target requests per second.",
"format": "int32"
},
"targetConcurrentRequests": {
"type": "integer",
"description": "Target number of concurrent requests.",
"format": "int32"
}
}
},
"DiskUtilization": {
"id": "DiskUtilization",
"type": "object",
"description": "Target scaling by disk usage (for VM runtimes only).",
"properties": {
"targetWriteBytesPerSec": {
"type": "integer",
"description": "Target bytes per second written.",
"format": "int32"
},
"targetWriteOpsPerSec": {
"type": "integer",
"description": "Target ops per second written.",
"format": "int32"
},
"targetReadBytesPerSec": {
"type": "integer",
"description": "Target bytes per second read.",
"format": "int32"
},
"targetReadOpsPerSec": {
"type": "integer",
"description": "Target ops per second read.",
"format": "int32"
}
}
},
"NetworkUtilization": {
"id": "NetworkUtilization",
"type": "object",
"description": "Target scaling by network usage (for VM runtimes only).",
"properties": {
"targetSentBytesPerSec": {
"type": "integer",
"description": "Target bytes per second sent.",
"format": "int32"
},
"targetSentPacketsPerSec": {
"type": "integer",
"description": "Target packets per second sent.",
"format": "int32"
},
"targetReceivedBytesPerSec": {
"type": "integer",
"description": "Target bytes per second received.",
"format": "int32"
},
"targetReceivedPacketsPerSec": {
"type": "integer",
"description": "Target packets per second received.",
"format": "int32"
}
}
},
"BasicScaling": {
"id": "BasicScaling",
"type": "object",
@@ -549,7 +636,7 @@
},
"requireMatchingFile": {
"type": "boolean",
"description": "If true, this [UrlMap][google.appengine.v1beta4.UrlMap] entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next [UrlMap][google.appengine.v1beta4.UrlMap] that matches the requested URL."
"description": "If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL."
},
"applicationReadable": {
"type": "boolean",
@@ -769,7 +856,7 @@
"properties": {
"sourceUrl": {
"type": "string",
"description": "The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage."
"description": "The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\\/\\'."
},
"sha1Sum": {
"type": "string",
@@ -845,16 +932,16 @@
"Status": {
"id": "Status",
"type": "object",
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.",
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.",
"properties": {
"code": {
"type": "integer",
"description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32"
},
"message": {
"type": "string",
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client."
},
"details": {
"type": "array",
@@ -951,7 +1038,7 @@
"ListOperationsResponse": {
"id": "ListOperationsResponse",
"type": "object",
"description": "The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].",
"description": "The response message for Operations.ListOperations.",
"properties": {
"operations": {
"type": "array",
@@ -969,7 +1056,7 @@
"OperationMetadata": {
"id": "OperationMetadata",
"type": "object",
"description": "Metadata for the given [google.longrunning.Operation][google.longrunning.Operation].",
"description": "Metadata for the given google.longrunning.Operation.",
"properties": {
"operationType": {
"type": "string",
@@ -996,6 +1083,33 @@
"description": "API method name that initiated the operation. Example: \"google.appengine.v1beta4.Version.CreateVersion\". @OutputOnly"
}
}
},
"OperationMetadataV1Beta5": {
"id": "OperationMetadataV1Beta5",
"type": "object",
"description": "Metadata for the given google.longrunning.Operation.",
"properties": {
"method": {
"type": "string",
"description": "API method name that initiated the operation. Example: \"google.appengine.v1beta5.Version.CreateVersion\". @OutputOnly"
},
"insertTime": {
"type": "string",
"description": "Timestamp that this operation was received. @OutputOnly"
},
"endTime": {
"type": "string",
"description": "Timestamp that this operation was completed. (Not present if the operation is still in progress.) @OutputOnly"
},
"user": {
"type": "string",
"description": "The user who requested this operation. @OutputOnly"
},
"target": {
"type": "string",
"description": "Resource that this operation is acting on. Example: \"apps/myapp/services/default\". @OutputOnly"
}
}
}
},
"resources": {
@@ -1015,7 +1129,7 @@
},
"ensureResourcesExist": {
"type": "boolean",
"description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the `GET` operation. If specified and any resources cloud not be created, the request will fail with an error code.",
"description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the `GET` operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.",
"location": "query"
}
},