mirror of
https://github.com/Luzifer/nginx-sso.git
synced 2024-12-25 15:21:16 +00:00
1260 lines
No EOL
55 KiB
JSON
1260 lines
No EOL
55 KiB
JSON
{
|
|
"auth": {
|
|
"oauth2": {
|
|
"scopes": {
|
|
"https://www.googleapis.com/auth/appengine.admin": {
|
|
"description": "View and manage your applications deployed on Google App Engine"
|
|
},
|
|
"https://www.googleapis.com/auth/cloud-platform": {
|
|
"description": "View and manage your data across Google Cloud Platform services"
|
|
},
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only": {
|
|
"description": "View your data across Google Cloud Platform services"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"basePath": "",
|
|
"baseUrl": "https://appengine.googleapis.com/",
|
|
"batchPath": "batch",
|
|
"description": "Provisions and manages developers' App Engine applications.",
|
|
"discoveryVersion": "v1",
|
|
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
|
|
"icons": {
|
|
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
|
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
|
},
|
|
"id": "appengine:v1alpha",
|
|
"kind": "discovery#restDescription",
|
|
"name": "appengine",
|
|
"ownerDomain": "google.com",
|
|
"ownerName": "Google",
|
|
"parameters": {
|
|
"$.xgafv": {
|
|
"description": "V1 error format.",
|
|
"enum": [
|
|
"1",
|
|
"2"
|
|
],
|
|
"enumDescriptions": [
|
|
"v1 error format",
|
|
"v2 error format"
|
|
],
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"access_token": {
|
|
"description": "OAuth access token.",
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"alt": {
|
|
"default": "json",
|
|
"description": "Data format for response.",
|
|
"enum": [
|
|
"json",
|
|
"media",
|
|
"proto"
|
|
],
|
|
"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",
|
|
"type": "string"
|
|
},
|
|
"callback": {
|
|
"description": "JSONP",
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"fields": {
|
|
"description": "Selector specifying which fields to include in a partial response.",
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"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.",
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"oauth_token": {
|
|
"description": "OAuth 2.0 token for the current user.",
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"prettyPrint": {
|
|
"default": "true",
|
|
"description": "Returns response with indentations and line breaks.",
|
|
"location": "query",
|
|
"type": "boolean"
|
|
},
|
|
"quotaUser": {
|
|
"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.",
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"uploadType": {
|
|
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"upload_protocol": {
|
|
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"protocol": "rest",
|
|
"resources": {
|
|
"apps": {
|
|
"resources": {
|
|
"authorizedCertificates": {
|
|
"methods": {
|
|
"create": {
|
|
"description": "Uploads the specified SSL certificate.",
|
|
"flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
|
|
"httpMethod": "POST",
|
|
"id": "appengine.apps.authorizedCertificates.create",
|
|
"parameterOrder": [
|
|
"appsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/authorizedCertificates",
|
|
"request": {
|
|
"$ref": "AuthorizedCertificate"
|
|
},
|
|
"response": {
|
|
"$ref": "AuthorizedCertificate"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
},
|
|
"delete": {
|
|
"description": "Deletes the specified SSL certificate.",
|
|
"flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
|
|
"httpMethod": "DELETE",
|
|
"id": "appengine.apps.authorizedCertificates.delete",
|
|
"parameterOrder": [
|
|
"appsId",
|
|
"authorizedCertificatesId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"authorizedCertificatesId": {
|
|
"description": "Part of `name`. See documentation of `appsId`.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
},
|
|
"get": {
|
|
"description": "Gets the specified SSL certificate.",
|
|
"flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
|
|
"httpMethod": "GET",
|
|
"id": "appengine.apps.authorizedCertificates.get",
|
|
"parameterOrder": [
|
|
"appsId",
|
|
"authorizedCertificatesId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"authorizedCertificatesId": {
|
|
"description": "Part of `name`. See documentation of `appsId`.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"view": {
|
|
"description": "Controls the set of fields returned in the GET response.",
|
|
"enum": [
|
|
"BASIC_CERTIFICATE",
|
|
"FULL_CERTIFICATE"
|
|
],
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
|
|
"response": {
|
|
"$ref": "AuthorizedCertificate"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/appengine.admin",
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
|
]
|
|
},
|
|
"list": {
|
|
"description": "Lists all SSL certificates the user is authorized to administer.",
|
|
"flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
|
|
"httpMethod": "GET",
|
|
"id": "appengine.apps.authorizedCertificates.list",
|
|
"parameterOrder": [
|
|
"appsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"pageSize": {
|
|
"description": "Maximum results to return per page.",
|
|
"format": "int32",
|
|
"location": "query",
|
|
"type": "integer"
|
|
},
|
|
"pageToken": {
|
|
"description": "Continuation token for fetching the next page of results.",
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"view": {
|
|
"description": "Controls the set of fields returned in the LIST response.",
|
|
"enum": [
|
|
"BASIC_CERTIFICATE",
|
|
"FULL_CERTIFICATE"
|
|
],
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/authorizedCertificates",
|
|
"response": {
|
|
"$ref": "ListAuthorizedCertificatesResponse"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/appengine.admin",
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
|
]
|
|
},
|
|
"patch": {
|
|
"description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
|
|
"flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
|
|
"httpMethod": "PATCH",
|
|
"id": "appengine.apps.authorizedCertificates.patch",
|
|
"parameterOrder": [
|
|
"appsId",
|
|
"authorizedCertificatesId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"authorizedCertificatesId": {
|
|
"description": "Part of `name`. See documentation of `appsId`.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"updateMask": {
|
|
"description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
|
|
"format": "google-fieldmask",
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
|
|
"request": {
|
|
"$ref": "AuthorizedCertificate"
|
|
},
|
|
"response": {
|
|
"$ref": "AuthorizedCertificate"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"authorizedDomains": {
|
|
"methods": {
|
|
"list": {
|
|
"description": "Lists all domains the user is authorized to administer.",
|
|
"flatPath": "v1alpha/apps/{appsId}/authorizedDomains",
|
|
"httpMethod": "GET",
|
|
"id": "appengine.apps.authorizedDomains.list",
|
|
"parameterOrder": [
|
|
"appsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"pageSize": {
|
|
"description": "Maximum results to return per page.",
|
|
"format": "int32",
|
|
"location": "query",
|
|
"type": "integer"
|
|
},
|
|
"pageToken": {
|
|
"description": "Continuation token for fetching the next page of results.",
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/authorizedDomains",
|
|
"response": {
|
|
"$ref": "ListAuthorizedDomainsResponse"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/appengine.admin",
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"domainMappings": {
|
|
"methods": {
|
|
"create": {
|
|
"description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
|
|
"flatPath": "v1alpha/apps/{appsId}/domainMappings",
|
|
"httpMethod": "POST",
|
|
"id": "appengine.apps.domainMappings.create",
|
|
"parameterOrder": [
|
|
"appsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"noManagedCertificate": {
|
|
"description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated.",
|
|
"location": "query",
|
|
"type": "boolean"
|
|
},
|
|
"overrideStrategy": {
|
|
"description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
|
|
"enum": [
|
|
"UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
|
|
"STRICT",
|
|
"OVERRIDE"
|
|
],
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/domainMappings",
|
|
"request": {
|
|
"$ref": "DomainMapping"
|
|
},
|
|
"response": {
|
|
"$ref": "Operation"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
},
|
|
"delete": {
|
|
"description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
|
|
"flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
|
|
"httpMethod": "DELETE",
|
|
"id": "appengine.apps.domainMappings.delete",
|
|
"parameterOrder": [
|
|
"appsId",
|
|
"domainMappingsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"domainMappingsId": {
|
|
"description": "Part of `name`. See documentation of `appsId`.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
|
|
"response": {
|
|
"$ref": "Operation"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
},
|
|
"get": {
|
|
"description": "Gets the specified domain mapping.",
|
|
"flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
|
|
"httpMethod": "GET",
|
|
"id": "appengine.apps.domainMappings.get",
|
|
"parameterOrder": [
|
|
"appsId",
|
|
"domainMappingsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"domainMappingsId": {
|
|
"description": "Part of `name`. See documentation of `appsId`.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
|
|
"response": {
|
|
"$ref": "DomainMapping"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/appengine.admin",
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
|
]
|
|
},
|
|
"list": {
|
|
"description": "Lists the domain mappings on an application.",
|
|
"flatPath": "v1alpha/apps/{appsId}/domainMappings",
|
|
"httpMethod": "GET",
|
|
"id": "appengine.apps.domainMappings.list",
|
|
"parameterOrder": [
|
|
"appsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"pageSize": {
|
|
"description": "Maximum results to return per page.",
|
|
"format": "int32",
|
|
"location": "query",
|
|
"type": "integer"
|
|
},
|
|
"pageToken": {
|
|
"description": "Continuation token for fetching the next page of results.",
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/domainMappings",
|
|
"response": {
|
|
"$ref": "ListDomainMappingsResponse"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/appengine.admin",
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
|
]
|
|
},
|
|
"patch": {
|
|
"description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
|
|
"flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
|
|
"httpMethod": "PATCH",
|
|
"id": "appengine.apps.domainMappings.patch",
|
|
"parameterOrder": [
|
|
"appsId",
|
|
"domainMappingsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"domainMappingsId": {
|
|
"description": "Part of `name`. See documentation of `appsId`.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"noManagedCertificate": {
|
|
"description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.",
|
|
"location": "query",
|
|
"type": "boolean"
|
|
},
|
|
"updateMask": {
|
|
"description": "Standard field mask for the set of fields to be updated.",
|
|
"format": "google-fieldmask",
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
|
|
"request": {
|
|
"$ref": "DomainMapping"
|
|
},
|
|
"response": {
|
|
"$ref": "Operation"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"locations": {
|
|
"methods": {
|
|
"get": {
|
|
"description": "Gets information about a location.",
|
|
"flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
|
|
"httpMethod": "GET",
|
|
"id": "appengine.apps.locations.get",
|
|
"parameterOrder": [
|
|
"appsId",
|
|
"locationsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `name`. Resource name for the location.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"locationsId": {
|
|
"description": "Part of `name`. See documentation of `appsId`.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/locations/{locationsId}",
|
|
"response": {
|
|
"$ref": "Location"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/appengine.admin",
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
|
]
|
|
},
|
|
"list": {
|
|
"description": "Lists information about the supported locations for this service.",
|
|
"flatPath": "v1alpha/apps/{appsId}/locations",
|
|
"httpMethod": "GET",
|
|
"id": "appengine.apps.locations.list",
|
|
"parameterOrder": [
|
|
"appsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"filter": {
|
|
"description": "The standard list filter.",
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"pageSize": {
|
|
"description": "The standard list page size.",
|
|
"format": "int32",
|
|
"location": "query",
|
|
"type": "integer"
|
|
},
|
|
"pageToken": {
|
|
"description": "The standard list page token.",
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/locations",
|
|
"response": {
|
|
"$ref": "ListLocationsResponse"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/appengine.admin",
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"operations": {
|
|
"methods": {
|
|
"get": {
|
|
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
|
|
"flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
|
|
"httpMethod": "GET",
|
|
"id": "appengine.apps.operations.get",
|
|
"parameterOrder": [
|
|
"appsId",
|
|
"operationsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `name`. The name of the operation resource.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"operationsId": {
|
|
"description": "Part of `name`. See documentation of `appsId`.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/operations/{operationsId}",
|
|
"response": {
|
|
"$ref": "Operation"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/appengine.admin",
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
|
]
|
|
},
|
|
"list": {
|
|
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
|
|
"flatPath": "v1alpha/apps/{appsId}/operations",
|
|
"httpMethod": "GET",
|
|
"id": "appengine.apps.operations.list",
|
|
"parameterOrder": [
|
|
"appsId"
|
|
],
|
|
"parameters": {
|
|
"appsId": {
|
|
"description": "Part of `name`. The name of the operation's parent resource.",
|
|
"location": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"filter": {
|
|
"description": "The standard list filter.",
|
|
"location": "query",
|
|
"type": "string"
|
|
},
|
|
"pageSize": {
|
|
"description": "The standard list page size.",
|
|
"format": "int32",
|
|
"location": "query",
|
|
"type": "integer"
|
|
},
|
|
"pageToken": {
|
|
"description": "The standard list page token.",
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1alpha/apps/{appsId}/operations",
|
|
"response": {
|
|
"$ref": "ListOperationsResponse"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/appengine.admin",
|
|
"https://www.googleapis.com/auth/cloud-platform",
|
|
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"revision": "20190214",
|
|
"rootUrl": "https://appengine.googleapis.com/",
|
|
"schemas": {
|
|
"AuthorizedCertificate": {
|
|
"description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
|
|
"id": "AuthorizedCertificate",
|
|
"properties": {
|
|
"certificateRawData": {
|
|
"$ref": "CertificateRawData",
|
|
"description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
|
|
},
|
|
"displayName": {
|
|
"description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
|
|
"type": "string"
|
|
},
|
|
"domainMappingsCount": {
|
|
"description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"domainNames": {
|
|
"description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"expireTime": {
|
|
"description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"managedCertificate": {
|
|
"$ref": "ManagedCertificate",
|
|
"description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly"
|
|
},
|
|
"name": {
|
|
"description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"visibleDomainMappings": {
|
|
"description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"AuthorizedDomain": {
|
|
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
|
|
"id": "AuthorizedDomain",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"CertificateRawData": {
|
|
"description": "An SSL certificate obtained from a certificate authority.",
|
|
"id": "CertificateRawData",
|
|
"properties": {
|
|
"privateKey": {
|
|
"description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
|
|
"type": "string"
|
|
},
|
|
"publicCertificate": {
|
|
"description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"CreateVersionMetadataV1": {
|
|
"description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.",
|
|
"id": "CreateVersionMetadataV1",
|
|
"properties": {
|
|
"cloudBuildId": {
|
|
"description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"CreateVersionMetadataV1Alpha": {
|
|
"description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
|
|
"id": "CreateVersionMetadataV1Alpha",
|
|
"properties": {
|
|
"cloudBuildId": {
|
|
"description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"CreateVersionMetadataV1Beta": {
|
|
"description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
|
|
"id": "CreateVersionMetadataV1Beta",
|
|
"properties": {
|
|
"cloudBuildId": {
|
|
"description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"DomainMapping": {
|
|
"description": "A domain serving an App Engine application.",
|
|
"id": "DomainMapping",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Relative name of the domain serving the application. Example: example.com.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"resourceRecords": {
|
|
"description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
|
|
"items": {
|
|
"$ref": "ResourceRecord"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"sslSettings": {
|
|
"$ref": "SslSettings",
|
|
"description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"Empty": {
|
|
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
|
|
"id": "Empty",
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
"ListAuthorizedCertificatesResponse": {
|
|
"description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
|
|
"id": "ListAuthorizedCertificatesResponse",
|
|
"properties": {
|
|
"certificates": {
|
|
"description": "The SSL certificates the user is authorized to administer.",
|
|
"items": {
|
|
"$ref": "AuthorizedCertificate"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"nextPageToken": {
|
|
"description": "Continuation token for fetching the next page of results.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ListAuthorizedDomainsResponse": {
|
|
"description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
|
|
"id": "ListAuthorizedDomainsResponse",
|
|
"properties": {
|
|
"domains": {
|
|
"description": "The authorized domains belonging to the user.",
|
|
"items": {
|
|
"$ref": "AuthorizedDomain"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"nextPageToken": {
|
|
"description": "Continuation token for fetching the next page of results.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ListDomainMappingsResponse": {
|
|
"description": "Response message for DomainMappings.ListDomainMappings.",
|
|
"id": "ListDomainMappingsResponse",
|
|
"properties": {
|
|
"domainMappings": {
|
|
"description": "The domain mappings for the application.",
|
|
"items": {
|
|
"$ref": "DomainMapping"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"nextPageToken": {
|
|
"description": "Continuation token for fetching the next page of results.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ListLocationsResponse": {
|
|
"description": "The response message for Locations.ListLocations.",
|
|
"id": "ListLocationsResponse",
|
|
"properties": {
|
|
"locations": {
|
|
"description": "A list of locations that matches the specified filter in the request.",
|
|
"items": {
|
|
"$ref": "Location"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"nextPageToken": {
|
|
"description": "The standard List next-page token.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ListOperationsResponse": {
|
|
"description": "The response message for Operations.ListOperations.",
|
|
"id": "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"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"Location": {
|
|
"description": "A resource that represents Google Cloud Platform location.",
|
|
"id": "Location",
|
|
"properties": {
|
|
"displayName": {
|
|
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
|
|
"type": "string"
|
|
},
|
|
"labels": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
|
|
"type": "object"
|
|
},
|
|
"locationId": {
|
|
"description": "The canonical id for this location. For example: \"us-east1\".",
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"additionalProperties": {
|
|
"description": "Properties of the object. Contains field @type with type URL.",
|
|
"type": "any"
|
|
},
|
|
"description": "Service-specific metadata. For example the available capacity at the given location.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"LocationMetadata": {
|
|
"description": "Metadata for the given google.cloud.location.Location.",
|
|
"id": "LocationMetadata",
|
|
"properties": {
|
|
"flexibleEnvironmentAvailable": {
|
|
"description": "App Engine flexible environment is available in the given location.@OutputOnly",
|
|
"type": "boolean"
|
|
},
|
|
"standardEnvironmentAvailable": {
|
|
"description": "App Engine standard environment is available in the given location.@OutputOnly",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ManagedCertificate": {
|
|
"description": "A certificate managed by App Engine.",
|
|
"id": "ManagedCertificate",
|
|
"properties": {
|
|
"lastRenewalTime": {
|
|
"description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
|
|
"enum": [
|
|
"UNSPECIFIED_STATUS",
|
|
"OK",
|
|
"PENDING",
|
|
"FAILED_RETRYING_INTERNAL",
|
|
"FAILED_RETRYING_NOT_VISIBLE",
|
|
"FAILED_PERMANENTLY_NOT_VISIBLE",
|
|
"FAILED_RETRYING_CAA_FORBIDDEN",
|
|
"FAILED_RETRYING_CAA_CHECKING"
|
|
],
|
|
"enumDescriptions": [
|
|
"",
|
|
"Certificate was successfully obtained and inserted into the serving system.",
|
|
"Certificate is under active attempts to acquire or renew.",
|
|
"Most recent renewal failed due to a system failure and will be retried. System failure is likely transient, and subsequent renewal attempts may succeed. The last successfully provisioned certificate may still be serving.",
|
|
"Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
|
|
"All renewal attempts have been exhausted. Most recent renewal failed due to an invalid DNS setup and will not be retried. The last successfully provisioned certificate may still be serving.",
|
|
"Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
|
|
"Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"Operation": {
|
|
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
|
"id": "Operation",
|
|
"properties": {
|
|
"done": {
|
|
"description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
|
|
"type": "boolean"
|
|
},
|
|
"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 contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
|
|
"type": "object"
|
|
},
|
|
"name": {
|
|
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
|
|
"type": "string"
|
|
},
|
|
"response": {
|
|
"additionalProperties": {
|
|
"description": "Properties of the object. Contains field @type with type URL.",
|
|
"type": "any"
|
|
},
|
|
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"OperationMetadataV1": {
|
|
"description": "Metadata for the given google.longrunning.Operation.",
|
|
"id": "OperationMetadataV1",
|
|
"properties": {
|
|
"createVersionMetadata": {
|
|
"$ref": "CreateVersionMetadataV1"
|
|
},
|
|
"endTime": {
|
|
"description": "Time that this operation completed.@OutputOnly",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"ephemeralMessage": {
|
|
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"insertTime": {
|
|
"description": "Time that this operation was created.@OutputOnly",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"method": {
|
|
"description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"user": {
|
|
"description": "User who requested this operation.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"warning": {
|
|
"description": "Durable messages that persist on every operation poll. @OutputOnly",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"OperationMetadataV1Alpha": {
|
|
"description": "Metadata for the given google.longrunning.Operation.",
|
|
"id": "OperationMetadataV1Alpha",
|
|
"properties": {
|
|
"createVersionMetadata": {
|
|
"$ref": "CreateVersionMetadataV1Alpha"
|
|
},
|
|
"endTime": {
|
|
"description": "Time that this operation completed.@OutputOnly",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"ephemeralMessage": {
|
|
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"insertTime": {
|
|
"description": "Time that this operation was created.@OutputOnly",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"method": {
|
|
"description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"user": {
|
|
"description": "User who requested this operation.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"warning": {
|
|
"description": "Durable messages that persist on every operation poll. @OutputOnly",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"OperationMetadataV1Beta": {
|
|
"description": "Metadata for the given google.longrunning.Operation.",
|
|
"id": "OperationMetadataV1Beta",
|
|
"properties": {
|
|
"createVersionMetadata": {
|
|
"$ref": "CreateVersionMetadataV1Beta"
|
|
},
|
|
"endTime": {
|
|
"description": "Time that this operation completed.@OutputOnly",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"ephemeralMessage": {
|
|
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"insertTime": {
|
|
"description": "Time that this operation was created.@OutputOnly",
|
|
"format": "google-datetime",
|
|
"type": "string"
|
|
},
|
|
"method": {
|
|
"description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"user": {
|
|
"description": "User who requested this operation.@OutputOnly",
|
|
"type": "string"
|
|
},
|
|
"warning": {
|
|
"description": "Durable messages that persist on every operation poll. @OutputOnly",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ResourceRecord": {
|
|
"description": "A DNS resource record.",
|
|
"id": "ResourceRecord",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
|
|
"type": "string"
|
|
},
|
|
"rrdata": {
|
|
"description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"description": "Resource record type. Example: AAAA.",
|
|
"enum": [
|
|
"A",
|
|
"AAAA",
|
|
"CNAME"
|
|
],
|
|
"enumDescriptions": [
|
|
"An A resource record. Data is an IPv4 address.",
|
|
"An AAAA resource record. Data is an IPv6 address.",
|
|
"A CNAME resource record. Data is a domain name to be aliased."
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"SslSettings": {
|
|
"description": "SSL configuration for a DomainMapping resource.",
|
|
"id": "SslSettings",
|
|
"properties": {
|
|
"certificateId": {
|
|
"description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
|
|
"type": "string"
|
|
},
|
|
"isManagedCertificate": {
|
|
"description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"Status": {
|
|
"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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
|
|
"id": "Status",
|
|
"properties": {
|
|
"code": {
|
|
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
|
"format": "int32",
|
|
"type": "integer"
|
|
},
|
|
"details": {
|
|
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
|
|
"items": {
|
|
"additionalProperties": {
|
|
"description": "Properties of the object. Contains field @type with type URL.",
|
|
"type": "any"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"message": {
|
|
"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.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"servicePath": "",
|
|
"title": "App Engine Admin API",
|
|
"version": "v1alpha"
|
|
} |