| Index: discovery/googleapis/servicemanagement__v1.json
|
| diff --git a/discovery/googleapis/servicemanagement__v1.json b/discovery/googleapis/servicemanagement__v1.json
|
| index 4e47d3d8b3604438ad1386328f78865f39dfd12d..2ff46d1c0ea1db5a8eaa91260deda8963355b120 100644
|
| --- a/discovery/googleapis/servicemanagement__v1.json
|
| +++ b/discovery/googleapis/servicemanagement__v1.json
|
| @@ -5,12 +5,12 @@
|
| "https://www.googleapis.com/auth/service.management": {
|
| "description": "Manage your Google API service configuration"
|
| },
|
| - "https://www.googleapis.com/auth/cloud-platform.read-only": {
|
| - "description": "View your data across Google Cloud Platform services"
|
| - },
|
| "https://www.googleapis.com/auth/service.management.readonly": {
|
| "description": "View your Google API service configuration"
|
| },
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only": {
|
| + "description": "View your data across Google Cloud Platform services"
|
| + },
|
| "https://www.googleapis.com/auth/cloud-platform": {
|
| "description": "View and manage your data across Google Cloud Platform services"
|
| }
|
| @@ -34,37 +34,6 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| - "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"
|
| - },
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "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"
|
| - },
|
| - "pp": {
|
| - "default": "true",
|
| - "description": "Pretty-print response.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "oauth_token": {
|
| - "description": "OAuth 2.0 token for the current user.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "bearer_token": {
|
| - "description": "OAuth bearer token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "upload_protocol": {
|
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| "location": "query",
|
| @@ -76,13 +45,18 @@
|
| "location": "query",
|
| "type": "boolean"
|
| },
|
| + "uploadType": {
|
| + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "fields": {
|
| "description": "Selector specifying which fields to include in a partial response.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| + "callback": {
|
| + "description": "JSONP",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -99,11 +73,6 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "callback": {
|
| - "description": "JSONP",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "alt": {
|
| "default": "json",
|
| "description": "Data format for response.",
|
| @@ -119,49 +88,43 @@
|
| ],
|
| "location": "query",
|
| "type": "string"
|
| + },
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "pp": {
|
| + "default": "true",
|
| + "description": "Pretty-print response.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "oauth_token": {
|
| + "description": "OAuth 2.0 token for the current user.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "bearer_token": {
|
| + "description": "OAuth bearer token.",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "protocol": "rest",
|
| "resources": {
|
| "operations": {
|
| "methods": {
|
| - "list": {
|
| - "description": "Lists service operations that match the specified filter in the request.",
|
| - "httpMethod": "GET",
|
| - "id": "servicemanagement.operations.list",
|
| - "parameterOrder": [],
|
| - "parameters": {
|
| - "name": {
|
| - "description": "Not used.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pageToken": {
|
| - "description": "The standard list page token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "filter": {
|
| - "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `>=`, `>`, `<=`, and `<`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime>=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime>=\"2017-02-01\")`",
|
| - "location": "query",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/operations",
|
| - "response": {
|
| - "$ref": "ListOperationsResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/service.management"
|
| - ]
|
| - },
|
| "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.",
|
| "httpMethod": "GET",
|
| @@ -186,86 +149,48 @@
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| "https://www.googleapis.com/auth/service.management"
|
| ]
|
| - }
|
| - }
|
| - },
|
| - "services": {
|
| - "methods": {
|
| + },
|
| "list": {
|
| - "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".",
|
| + "description": "Lists service operations that match the specified filter in the request.",
|
| "httpMethod": "GET",
|
| - "id": "servicemanagement.services.list",
|
| + "id": "servicemanagement.operations.list",
|
| "parameterOrder": [],
|
| "parameters": {
|
| - "consumerId": {
|
| - "description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:<project_id>",
|
| + "pageToken": {
|
| + "description": "The standard list page token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "pageToken": {
|
| - "description": "Token identifying which result to start with; returned by a previous list\ncall.",
|
| + "name": {
|
| + "description": "Not used.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Requested size of the next page of data.",
|
| + "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| },
|
| - "producerProjectId": {
|
| - "description": "Include services produced by the specified project.",
|
| + "filter": {
|
| + "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `>=`, `>`, `<=`, and `<`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime>=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime>=\"2017-02-01\")`",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services",
|
| - "response": {
|
| - "$ref": "ListServicesResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/cloud-platform.read-only",
|
| - "https://www.googleapis.com/auth/service.management",
|
| - "https://www.googleapis.com/auth/service.management.readonly"
|
| - ]
|
| - },
|
| - "create": {
|
| - "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation<response: ManagedService>",
|
| - "httpMethod": "POST",
|
| - "id": "servicemanagement.services.create",
|
| - "parameterOrder": [],
|
| - "parameters": {},
|
| - "path": "v1/services",
|
| - "request": {
|
| - "$ref": "ManagedService"
|
| - },
|
| - "response": {
|
| - "$ref": "Operation"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/service.management"
|
| - ]
|
| - },
|
| - "generateConfigReport": {
|
| - "description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.",
|
| - "httpMethod": "POST",
|
| - "id": "servicemanagement.services.generateConfigReport",
|
| - "parameterOrder": [],
|
| - "parameters": {},
|
| - "path": "v1/services:generateConfigReport",
|
| - "request": {
|
| - "$ref": "GenerateConfigReportRequest"
|
| - },
|
| + "path": "v1/operations",
|
| "response": {
|
| - "$ref": "GenerateConfigReportResponse"
|
| + "$ref": "ListOperationsResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| "https://www.googleapis.com/auth/service.management"
|
| ]
|
| - },
|
| + }
|
| + }
|
| + },
|
| + "services": {
|
| + "methods": {
|
| "get": {
|
| "description": "Gets a managed service. Authentication is required unless the service is\npublic.",
|
| "httpMethod": "GET",
|
| @@ -330,6 +255,15 @@
|
| "serviceName"
|
| ],
|
| "parameters": {
|
| + "view": {
|
| + "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
|
| + "enum": [
|
| + "BASIC",
|
| + "FULL"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "serviceName": {
|
| "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| "location": "path",
|
| @@ -340,15 +274,6 @@
|
| "description": "The id of the service configuration resource.",
|
| "location": "query",
|
| "type": "string"
|
| - },
|
| - "view": {
|
| - "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
|
| - "enum": [
|
| - "BASIC",
|
| - "FULL"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v1/services/{serviceName}/config",
|
| @@ -362,25 +287,22 @@
|
| "https://www.googleapis.com/auth/service.management.readonly"
|
| ]
|
| },
|
| - "enable": {
|
| - "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation<response: EnableServiceResponse>",
|
| - "httpMethod": "POST",
|
| - "id": "servicemanagement.services.enable",
|
| + "delete": {
|
| + "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation<response: google.protobuf.Empty>",
|
| + "httpMethod": "DELETE",
|
| + "id": "servicemanagement.services.delete",
|
| "parameterOrder": [
|
| "serviceName"
|
| ],
|
| "parameters": {
|
| "serviceName": {
|
| - "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
|
| + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}:enable",
|
| - "request": {
|
| - "$ref": "EnableServiceRequest"
|
| - },
|
| + "path": "v1/services/{serviceName}",
|
| "response": {
|
| "$ref": "Operation"
|
| },
|
| @@ -389,22 +311,25 @@
|
| "https://www.googleapis.com/auth/service.management"
|
| ]
|
| },
|
| - "delete": {
|
| - "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation<response: google.protobuf.Empty>",
|
| - "httpMethod": "DELETE",
|
| - "id": "servicemanagement.services.delete",
|
| + "enable": {
|
| + "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation<response: EnableServiceResponse>",
|
| + "httpMethod": "POST",
|
| + "id": "servicemanagement.services.enable",
|
| "parameterOrder": [
|
| "serviceName"
|
| ],
|
| "parameters": {
|
| "serviceName": {
|
| - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| + "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}",
|
| + "path": "v1/services/{serviceName}:enable",
|
| + "request": {
|
| + "$ref": "EnableServiceRequest"
|
| + },
|
| "response": {
|
| "$ref": "Operation"
|
| },
|
| @@ -521,44 +446,93 @@
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| "https://www.googleapis.com/auth/service.management"
|
| ]
|
| - }
|
| - },
|
| - "resources": {
|
| - "configs": {
|
| - "methods": {
|
| - "create": {
|
| - "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
|
| - "httpMethod": "POST",
|
| - "id": "servicemanagement.services.configs.create",
|
| - "parameterOrder": [
|
| - "serviceName"
|
| - ],
|
| - "parameters": {
|
| - "serviceName": {
|
| - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/services/{serviceName}/configs",
|
| - "request": {
|
| - "$ref": "Service"
|
| - },
|
| - "response": {
|
| - "$ref": "Service"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/service.management"
|
| - ]
|
| + },
|
| + "list": {
|
| + "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".",
|
| + "httpMethod": "GET",
|
| + "id": "servicemanagement.services.list",
|
| + "parameterOrder": [],
|
| + "parameters": {
|
| + "consumerId": {
|
| + "description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:<project_id>",
|
| + "location": "query",
|
| + "type": "string"
|
| },
|
| - "submit": {
|
| - "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation<response: SubmitConfigSourceResponse>",
|
| - "httpMethod": "POST",
|
| - "id": "servicemanagement.services.configs.submit",
|
| + "pageToken": {
|
| + "description": "Token identifying which result to start with; returned by a previous list\ncall.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Requested size of the next page of data.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "producerProjectId": {
|
| + "description": "Include services produced by the specified project.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/services",
|
| + "response": {
|
| + "$ref": "ListServicesResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only",
|
| + "https://www.googleapis.com/auth/service.management",
|
| + "https://www.googleapis.com/auth/service.management.readonly"
|
| + ]
|
| + },
|
| + "create": {
|
| + "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation<response: ManagedService>",
|
| + "httpMethod": "POST",
|
| + "id": "servicemanagement.services.create",
|
| + "parameterOrder": [],
|
| + "parameters": {},
|
| + "path": "v1/services",
|
| + "request": {
|
| + "$ref": "ManagedService"
|
| + },
|
| + "response": {
|
| + "$ref": "Operation"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/service.management"
|
| + ]
|
| + },
|
| + "generateConfigReport": {
|
| + "description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.",
|
| + "httpMethod": "POST",
|
| + "id": "servicemanagement.services.generateConfigReport",
|
| + "parameterOrder": [],
|
| + "parameters": {},
|
| + "path": "v1/services:generateConfigReport",
|
| + "request": {
|
| + "$ref": "GenerateConfigReportRequest"
|
| + },
|
| + "response": {
|
| + "$ref": "GenerateConfigReportResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/service.management"
|
| + ]
|
| + }
|
| + },
|
| + "resources": {
|
| + "configs": {
|
| + "methods": {
|
| + "get": {
|
| + "description": "Gets a service configuration (version) for a managed service.",
|
| + "httpMethod": "GET",
|
| + "id": "servicemanagement.services.configs.get",
|
| "parameterOrder": [
|
| - "serviceName"
|
| + "serviceName",
|
| + "configId"
|
| ],
|
| "parameters": {
|
| "serviceName": {
|
| @@ -566,18 +540,32 @@
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| + },
|
| + "configId": {
|
| + "description": "The id of the service configuration resource.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "view": {
|
| + "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
|
| + "enum": [
|
| + "BASIC",
|
| + "FULL"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}/configs:submit",
|
| - "request": {
|
| - "$ref": "SubmitConfigSourceRequest"
|
| - },
|
| + "path": "v1/services/{serviceName}/configs/{configId}",
|
| "response": {
|
| - "$ref": "Operation"
|
| + "$ref": "Service"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/service.management"
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only",
|
| + "https://www.googleapis.com/auth/service.management",
|
| + "https://www.googleapis.com/auth/service.management.readonly"
|
| ]
|
| },
|
| "list": {
|
| @@ -617,132 +605,144 @@
|
| "https://www.googleapis.com/auth/service.management.readonly"
|
| ]
|
| },
|
| - "get": {
|
| - "description": "Gets a service configuration (version) for a managed service.",
|
| - "httpMethod": "GET",
|
| - "id": "servicemanagement.services.configs.get",
|
| + "create": {
|
| + "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
|
| + "httpMethod": "POST",
|
| + "id": "servicemanagement.services.configs.create",
|
| "parameterOrder": [
|
| - "serviceName",
|
| - "configId"
|
| + "serviceName"
|
| ],
|
| "parameters": {
|
| - "view": {
|
| - "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
|
| - "enum": [
|
| - "BASIC",
|
| - "FULL"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "serviceName": {
|
| "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "configId": {
|
| - "description": "The id of the service configuration resource.",
|
| + }
|
| + },
|
| + "path": "v1/services/{serviceName}/configs",
|
| + "request": {
|
| + "$ref": "Service"
|
| + },
|
| + "response": {
|
| + "$ref": "Service"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/service.management"
|
| + ]
|
| + },
|
| + "submit": {
|
| + "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation<response: SubmitConfigSourceResponse>",
|
| + "httpMethod": "POST",
|
| + "id": "servicemanagement.services.configs.submit",
|
| + "parameterOrder": [
|
| + "serviceName"
|
| + ],
|
| + "parameters": {
|
| + "serviceName": {
|
| + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}/configs/{configId}",
|
| + "path": "v1/services/{serviceName}/configs:submit",
|
| + "request": {
|
| + "$ref": "SubmitConfigSourceRequest"
|
| + },
|
| "response": {
|
| - "$ref": "Service"
|
| + "$ref": "Operation"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/cloud-platform.read-only",
|
| - "https://www.googleapis.com/auth/service.management",
|
| - "https://www.googleapis.com/auth/service.management.readonly"
|
| + "https://www.googleapis.com/auth/service.management"
|
| ]
|
| }
|
| }
|
| },
|
| "consumers": {
|
| "methods": {
|
| - "setIamPolicy": {
|
| - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
| + "getIamPolicy": {
|
| + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
|
| "httpMethod": "POST",
|
| - "id": "servicemanagement.services.consumers.setIamPolicy",
|
| + "id": "servicemanagement.services.consumers.getIamPolicy",
|
| "parameterOrder": [
|
| "resource"
|
| ],
|
| "parameters": {
|
| "resource": {
|
| - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
|
| + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
| "location": "path",
|
| "pattern": "^services/[^/]+/consumers/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resource}:setIamPolicy",
|
| + "path": "v1/{+resource}:getIamPolicy",
|
| "request": {
|
| - "$ref": "SetIamPolicyRequest"
|
| + "$ref": "GetIamPolicyRequest"
|
| },
|
| "response": {
|
| "$ref": "Policy"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/service.management"
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only",
|
| + "https://www.googleapis.com/auth/service.management",
|
| + "https://www.googleapis.com/auth/service.management.readonly"
|
| ]
|
| },
|
| - "testIamPermissions": {
|
| - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
|
| + "setIamPolicy": {
|
| + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
| "httpMethod": "POST",
|
| - "id": "servicemanagement.services.consumers.testIamPermissions",
|
| + "id": "servicemanagement.services.consumers.setIamPolicy",
|
| "parameterOrder": [
|
| "resource"
|
| ],
|
| "parameters": {
|
| "resource": {
|
| - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
| + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
|
| "location": "path",
|
| "pattern": "^services/[^/]+/consumers/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resource}:testIamPermissions",
|
| + "path": "v1/{+resource}:setIamPolicy",
|
| "request": {
|
| - "$ref": "TestIamPermissionsRequest"
|
| + "$ref": "SetIamPolicyRequest"
|
| },
|
| "response": {
|
| - "$ref": "TestIamPermissionsResponse"
|
| + "$ref": "Policy"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| - "https://www.googleapis.com/auth/cloud-platform.read-only",
|
| - "https://www.googleapis.com/auth/service.management",
|
| - "https://www.googleapis.com/auth/service.management.readonly"
|
| + "https://www.googleapis.com/auth/service.management"
|
| ]
|
| },
|
| - "getIamPolicy": {
|
| - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
|
| + "testIamPermissions": {
|
| + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
|
| "httpMethod": "POST",
|
| - "id": "servicemanagement.services.consumers.getIamPolicy",
|
| + "id": "servicemanagement.services.consumers.testIamPermissions",
|
| "parameterOrder": [
|
| "resource"
|
| ],
|
| "parameters": {
|
| "resource": {
|
| - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
| + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
| "location": "path",
|
| "pattern": "^services/[^/]+/consumers/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+resource}:getIamPolicy",
|
| + "path": "v1/{+resource}:testIamPermissions",
|
| "request": {
|
| - "$ref": "GetIamPolicyRequest"
|
| + "$ref": "TestIamPermissionsRequest"
|
| },
|
| "response": {
|
| - "$ref": "Policy"
|
| + "$ref": "TestIamPermissionsResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -755,40 +755,31 @@
|
| },
|
| "rollouts": {
|
| "methods": {
|
| - "list": {
|
| - "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
|
| + "get": {
|
| + "description": "Gets a service configuration rollout.",
|
| "httpMethod": "GET",
|
| - "id": "servicemanagement.services.rollouts.list",
|
| + "id": "servicemanagement.services.rollouts.get",
|
| "parameterOrder": [
|
| - "serviceName"
|
| + "serviceName",
|
| + "rolloutId"
|
| ],
|
| "parameters": {
|
| - "pageToken": {
|
| - "description": "The token of the page to retrieve.",
|
| - "location": "query",
|
| + "serviceName": {
|
| + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| + "location": "path",
|
| + "required": true,
|
| "type": "string"
|
| },
|
| - "pageSize": {
|
| - "description": "The max number of items to include in the response list.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "filter": {
|
| - "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "serviceName": {
|
| - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
|
| + "rolloutId": {
|
| + "description": "The id of the rollout resource.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}/rollouts",
|
| + "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
|
| "response": {
|
| - "$ref": "ListServiceRolloutsResponse"
|
| + "$ref": "Rollout"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -797,13 +788,12 @@
|
| "https://www.googleapis.com/auth/service.management.readonly"
|
| ]
|
| },
|
| - "get": {
|
| - "description": "Gets a service configuration rollout.",
|
| + "list": {
|
| + "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
|
| "httpMethod": "GET",
|
| - "id": "servicemanagement.services.rollouts.get",
|
| + "id": "servicemanagement.services.rollouts.list",
|
| "parameterOrder": [
|
| - "serviceName",
|
| - "rolloutId"
|
| + "serviceName"
|
| ],
|
| "parameters": {
|
| "serviceName": {
|
| @@ -812,16 +802,26 @@
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "rolloutId": {
|
| - "description": "The id of the rollout resource.",
|
| - "location": "path",
|
| - "required": true,
|
| + "pageToken": {
|
| + "description": "The token of the page to retrieve.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "The max number of items to include in the response list.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "filter": {
|
| + "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'",
|
| + "location": "query",
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
|
| + "path": "v1/services/{serviceName}/rollouts",
|
| "response": {
|
| - "$ref": "Rollout"
|
| + "$ref": "ListServiceRolloutsResponse"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/cloud-platform",
|
| @@ -862,9 +862,210 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170602",
|
| + "revision": "20170626",
|
| "rootUrl": "https://servicemanagement.googleapis.com/",
|
| "schemas": {
|
| + "ConfigFile": {
|
| + "description": "Generic specification of a source configuration file",
|
| + "id": "ConfigFile",
|
| + "properties": {
|
| + "filePath": {
|
| + "description": "The file name of the configuration file (full or relative path).",
|
| + "type": "string"
|
| + },
|
| + "fileType": {
|
| + "description": "The type of configuration file this represents.",
|
| + "enum": [
|
| + "FILE_TYPE_UNSPECIFIED",
|
| + "SERVICE_CONFIG_YAML",
|
| + "OPEN_API_JSON",
|
| + "OPEN_API_YAML",
|
| + "FILE_DESCRIPTOR_SET_PROTO"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unknown file type.",
|
| + "YAML-specification of service.",
|
| + "OpenAPI specification, serialized in JSON.",
|
| + "OpenAPI specification, serialized in YAML.",
|
| + "FileDescriptorSet, generated by protoc.\n\nTo generate, use protoc with imports and source info included.\nFor an example test.proto file, the following command would put the value\nin a new file named out.pb.\n\n$protoc --include_imports --include_source_info test.proto -o out.pb"
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "fileContents": {
|
| + "description": "The bytes that constitute the file.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MonitoredResourceDescriptor": {
|
| + "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
|
| + "id": "MonitoredResourceDescriptor",
|
| + "properties": {
|
| + "labels": {
|
| + "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
|
| + "items": {
|
| + "$ref": "LabelDescriptor"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "name": {
|
| + "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
|
| + "type": "string"
|
| + },
|
| + "description": {
|
| + "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
|
| + "type": "string"
|
| + },
|
| + "displayName": {
|
| + "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
|
| + "type": "string"
|
| + },
|
| + "type": {
|
| + "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "CustomErrorRule": {
|
| + "description": "A custom error rule.",
|
| + "id": "CustomErrorRule",
|
| + "properties": {
|
| + "isErrorType": {
|
| + "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
|
| + "type": "boolean"
|
| + },
|
| + "selector": {
|
| + "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MediaDownload": {
|
| + "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
|
| + "id": "MediaDownload",
|
| + "properties": {
|
| + "enabled": {
|
| + "description": "Whether download is enabled.",
|
| + "type": "boolean"
|
| + },
|
| + "downloadService": {
|
| + "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
|
| + "type": "string"
|
| + },
|
| + "completeNotification": {
|
| + "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
|
| + "type": "boolean"
|
| + },
|
| + "maxDirectDownloadSize": {
|
| + "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "dropzone": {
|
| + "description": "Name of the Scotty dropzone to use for the current API.",
|
| + "type": "string"
|
| + },
|
| + "useDirectDownload": {
|
| + "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "CustomAuthRequirements": {
|
| + "description": "Configuration for a custom authentication provider.",
|
| + "id": "CustomAuthRequirements",
|
| + "properties": {
|
| + "provider": {
|
| + "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ChangeReport": {
|
| + "description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.",
|
| + "id": "ChangeReport",
|
| + "properties": {
|
| + "configChanges": {
|
| + "description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction",
|
| + "items": {
|
| + "$ref": "ConfigChange"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "DisableServiceRequest": {
|
| + "description": "Request message for DisableService method.",
|
| + "id": "DisableServiceRequest",
|
| + "properties": {
|
| + "consumerId": {
|
| + "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "SubmitConfigSourceResponse": {
|
| + "description": "Response message for SubmitConfigSource method.",
|
| + "id": "SubmitConfigSourceResponse",
|
| + "properties": {
|
| + "serviceConfig": {
|
| + "$ref": "Service",
|
| + "description": "The generated service configuration."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "MediaUpload": {
|
| + "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
|
| + "id": "MediaUpload",
|
| + "properties": {
|
| + "startNotification": {
|
| + "description": "Whether to receive a notification on the start of media upload.",
|
| + "type": "boolean"
|
| + },
|
| + "uploadService": {
|
| + "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
|
| + "type": "string"
|
| + },
|
| + "maxSize": {
|
| + "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "mimeTypes": {
|
| + "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "completeNotification": {
|
| + "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
|
| + "type": "boolean"
|
| + },
|
| + "progressNotification": {
|
| + "description": "Whether to receive a notification for progress changes of media upload.",
|
| + "type": "boolean"
|
| + },
|
| + "enabled": {
|
| + "description": "Whether upload is enabled.",
|
| + "type": "boolean"
|
| + },
|
| + "dropzone": {
|
| + "description": "Name of the Scotty dropzone to use for the current API.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "Advice": {
|
| "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
|
| "id": "Advice",
|
| @@ -899,6 +1100,10 @@
|
| "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
|
| "type": "string"
|
| },
|
| + "skipServiceControl": {
|
| + "description": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.",
|
| + "type": "boolean"
|
| + },
|
| "allowUnregisteredCalls": {
|
| "description": "True, if the method allows unregistered calls; false otherwise.",
|
| "type": "boolean"
|
| @@ -906,21 +1111,6 @@
|
| },
|
| "type": "object"
|
| },
|
| - "AuthRequirement": {
|
| - "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
|
| - "id": "AuthRequirement",
|
| - "properties": {
|
| - "audiences": {
|
| - "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
|
| - "type": "string"
|
| - },
|
| - "providerId": {
|
| - "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "TrafficPercentStrategy": {
|
| "description": "Strategy that specifies how clients of Google Service Controller want to\nsend traffic to use different config versions. This is generally\nused by API proxy to split traffic based on your configured precentage for\neach config version.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }",
|
| "id": "TrafficPercentStrategy",
|
| @@ -936,6 +1126,21 @@
|
| },
|
| "type": "object"
|
| },
|
| + "AuthRequirement": {
|
| + "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
|
| + "id": "AuthRequirement",
|
| + "properties": {
|
| + "providerId": {
|
| + "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
|
| + "type": "string"
|
| + },
|
| + "audiences": {
|
| + "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "Documentation": {
|
| "description": "`Documentation` provides the information for describing a service.\n\nExample:\n<pre><code>documentation:\n summary: >\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: >\n ...\n - selector: google.calendar.Calendar.Put\n description: >\n ...\n</code></pre>\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n<pre><code>[fully.qualified.proto.name][]</code></pre>\nTo override the display text used for the link, this can be used:\n<pre><code>[display text][fully.qualified.proto.name]</code></pre>\nText can be excluded from doc using the following notation:\n<pre><code>(-- internal comment --)</code></pre>\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n<pre><code>(--BETA: comment for BETA users --)</code></pre>\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n<pre><code>(== include path/to/file ==)</code></pre>\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n<pre><code>(== resource_for v1.shelves.books ==)</code></pre>\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
|
| "id": "Documentation",
|
| @@ -948,6 +1153,10 @@
|
| "description": "The URL to the root of documentation.",
|
| "type": "string"
|
| },
|
| + "overview": {
|
| + "description": "Declares a single overview page. For example:\n<pre><code>documentation:\n summary: ...\n overview: (== include overview.md ==)\n</code></pre>\nThis is a shortcut for the following declaration (using pages style):\n<pre><code>documentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n</code></pre>\nNote: you cannot specify both `overview` field and `pages` field.",
|
| + "type": "string"
|
| + },
|
| "rules": {
|
| "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| @@ -955,10 +1164,6 @@
|
| },
|
| "type": "array"
|
| },
|
| - "overview": {
|
| - "description": "Declares a single overview page. For example:\n<pre><code>documentation:\n summary: ...\n overview: (== include overview.md ==)\n</code></pre>\nThis is a shortcut for the following declaration (using pages style):\n<pre><code>documentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n</code></pre>\nNote: you cannot specify both `overview` field and `pages` field.",
|
| - "type": "string"
|
| - },
|
| "pages": {
|
| "description": "The top level pages for the documentation set.",
|
| "items": {
|
| @@ -973,8 +1178,8 @@
|
| "description": "A condition to be met.",
|
| "id": "Condition",
|
| "properties": {
|
| - "value": {
|
| - "description": "DEPRECATED. Use 'values' instead.",
|
| + "svc": {
|
| + "description": "Trusted attributes discharged by the service.",
|
| "type": "string"
|
| },
|
| "sys": {
|
| @@ -995,6 +1200,10 @@
|
| ],
|
| "type": "string"
|
| },
|
| + "value": {
|
| + "description": "DEPRECATED. Use 'values' instead.",
|
| + "type": "string"
|
| + },
|
| "iam": {
|
| "description": "Trusted attributes supplied by the IAM system.",
|
| "enum": [
|
| @@ -1039,10 +1248,6 @@
|
| "Subject is discharged"
|
| ],
|
| "type": "string"
|
| - },
|
| - "svc": {
|
| - "description": "Trusted attributes discharged by the service.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1081,16 +1286,16 @@
|
| "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
|
| "id": "ConfigSource",
|
| "properties": {
|
| + "id": {
|
| + "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
|
| + "type": "string"
|
| + },
|
| "files": {
|
| "description": "Set of source configuration files that are used to generate a service\nconfiguration (`google.api.Service`).",
|
| "items": {
|
| "$ref": "ConfigFile"
|
| },
|
| "type": "array"
|
| - },
|
| - "id": {
|
| - "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1099,14 +1304,14 @@
|
| "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
|
| "id": "AuthenticationRule",
|
| "properties": {
|
| - "oauth": {
|
| - "$ref": "OAuthRequirements",
|
| - "description": "The requirements for OAuth credentials."
|
| - },
|
| "customAuth": {
|
| "$ref": "CustomAuthRequirements",
|
| "description": "Configuration for custom authentication."
|
| },
|
| + "oauth": {
|
| + "$ref": "OAuthRequirements",
|
| + "description": "The requirements for OAuth credentials."
|
| + },
|
| "requirements": {
|
| "description": "Requirements for additional authentication providers.",
|
| "items": {
|
| @@ -1114,13 +1319,13 @@
|
| },
|
| "type": "array"
|
| },
|
| - "selector": {
|
| - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| - "type": "string"
|
| - },
|
| "allowWithoutCredential": {
|
| "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
|
| "type": "boolean"
|
| + },
|
| + "selector": {
|
| + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1129,6 +1334,11 @@
|
| "description": "A backend rule provides configuration for an individual API element.",
|
| "id": "BackendRule",
|
| "properties": {
|
| + "minDeadline": {
|
| + "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| "address": {
|
| "description": "The address of the API backend.",
|
| "type": "string"
|
| @@ -1141,11 +1351,17 @@
|
| "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
|
| "format": "double",
|
| "type": "number"
|
| - },
|
| - "minDeadline": {
|
| - "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
|
| - "format": "double",
|
| - "type": "number"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "UndeleteServiceResponse": {
|
| + "description": "Response message for UndeleteService method.",
|
| + "id": "UndeleteServiceResponse",
|
| + "properties": {
|
| + "service": {
|
| + "$ref": "ManagedService",
|
| + "description": "Revived service resource."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1154,20 +1370,6 @@
|
| "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
|
| "id": "Policy",
|
| "properties": {
|
| - "auditConfigs": {
|
| - "description": "Specifies cloud audit logging configuration for this policy.",
|
| - "items": {
|
| - "$ref": "AuditConfig"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "bindings": {
|
| - "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
| - "items": {
|
| - "$ref": "Binding"
|
| - },
|
| - "type": "array"
|
| - },
|
| "etag": {
|
| "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
| "format": "byte",
|
| @@ -1187,17 +1389,20 @@
|
| "description": "Version of the `Policy`. The default version is 0.",
|
| "format": "int32",
|
| "type": "integer"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "UndeleteServiceResponse": {
|
| - "description": "Response message for UndeleteService method.",
|
| - "id": "UndeleteServiceResponse",
|
| - "properties": {
|
| - "service": {
|
| - "$ref": "ManagedService",
|
| - "description": "Revived service resource."
|
| + },
|
| + "auditConfigs": {
|
| + "description": "Specifies cloud audit logging configuration for this policy.",
|
| + "items": {
|
| + "$ref": "AuditConfig"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "bindings": {
|
| + "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
| + "items": {
|
| + "$ref": "Binding"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1206,21 +1411,10 @@
|
| "description": "Api is a light-weight descriptor for a protocol buffer service.",
|
| "id": "Api",
|
| "properties": {
|
| - "methods": {
|
| - "description": "The methods of this api, in unspecified order.",
|
| - "items": {
|
| - "$ref": "Method"
|
| - },
|
| - "type": "array"
|
| - },
|
| "name": {
|
| "description": "The fully qualified name of this api, including package name\nfollowed by the api's simple name.",
|
| "type": "string"
|
| },
|
| - "sourceContext": {
|
| - "$ref": "SourceContext",
|
| - "description": "Source context for the protocol buffer service represented by this\nmessage."
|
| - },
|
| "syntax": {
|
| "description": "The source syntax of the service.",
|
| "enum": [
|
| @@ -1233,6 +1427,10 @@
|
| ],
|
| "type": "string"
|
| },
|
| + "sourceContext": {
|
| + "$ref": "SourceContext",
|
| + "description": "Source context for the protocol buffer service represented by this\nmessage."
|
| + },
|
| "version": {
|
| "description": "A version string for this api. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version\nis omitted, it defaults to zero. If the entire version field is\nempty, the major version is derived from the package name, as\noutlined below. If the field is not empty, the version in the\npackage name will be verified to be consistent with what is\nprovided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\nAPI, which must end in `v<major-version>`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, none-GA apis.\n",
|
| "type": "string"
|
| @@ -1250,18 +1448,27 @@
|
| "$ref": "Option"
|
| },
|
| "type": "array"
|
| + },
|
| + "methods": {
|
| + "description": "The methods of this api, in unspecified order.",
|
| + "items": {
|
| + "$ref": "Method"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| + "DataAccessOptions": {
|
| + "description": "Write a Data Access (Gin) log",
|
| + "id": "DataAccessOptions",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| "MetricRule": {
|
| "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
|
| "id": "MetricRule",
|
| "properties": {
|
| - "selector": {
|
| - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| - "type": "string"
|
| - },
|
| "metricCosts": {
|
| "additionalProperties": {
|
| "format": "int64",
|
| @@ -1269,16 +1476,14 @@
|
| },
|
| "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.",
|
| "type": "object"
|
| + },
|
| + "selector": {
|
| + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "DataAccessOptions": {
|
| - "description": "Write a Data Access (Gin) log",
|
| - "id": "DataAccessOptions",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| "Authentication": {
|
| "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
|
| "id": "Authentication",
|
| @@ -1361,11 +1566,6 @@
|
| "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.",
|
| "id": "Status",
|
| "properties": {
|
| - "code": {
|
| - "description": "The status code, which should be an enum value of google.rpc.Code.",
|
| - "format": "int32",
|
| - "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"
|
| @@ -1380,6 +1580,11 @@
|
| "type": "object"
|
| },
|
| "type": "array"
|
| + },
|
| + "code": {
|
| + "description": "The status code, which should be an enum value of google.rpc.Code.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1410,21 +1615,21 @@
|
| "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
|
| "id": "AuthProvider",
|
| "properties": {
|
| - "audiences": {
|
| - "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
|
| + "issuer": {
|
| + "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com",
|
| "type": "string"
|
| },
|
| "id": {
|
| "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".",
|
| "type": "string"
|
| },
|
| - "issuer": {
|
| - "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com",
|
| - "type": "string"
|
| - },
|
| "jwksUri": {
|
| "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs",
|
| "type": "string"
|
| + },
|
| + "audiences": {
|
| + "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1433,6 +1638,15 @@
|
| "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
|
| "id": "Service",
|
| "properties": {
|
| + "control": {
|
| + "$ref": "Control",
|
| + "description": "Configuration for the service control plane."
|
| + },
|
| + "configVersion": {
|
| + "description": "The version of the service configuration. The config version may\ninfluence interpretation of the configuration, for example, to\ndetermine defaults. This is documented together with applicable\noptions. The current default for the config version itself is `3`.",
|
| + "format": "uint32",
|
| + "type": "integer"
|
| + },
|
| "monitoring": {
|
| "$ref": "Monitoring",
|
| "description": "Monitoring configuration."
|
| @@ -1475,17 +1689,17 @@
|
| },
|
| "type": "array"
|
| },
|
| - "logs": {
|
| - "description": "Defines the logs used by this service.",
|
| + "apis": {
|
| + "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
|
| "items": {
|
| - "$ref": "LogDescriptor"
|
| + "$ref": "Api"
|
| },
|
| "type": "array"
|
| },
|
| - "apis": {
|
| - "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
|
| + "logs": {
|
| + "description": "Defines the logs used by this service.",
|
| "items": {
|
| - "$ref": "Api"
|
| + "$ref": "LogDescriptor"
|
| },
|
| "type": "array"
|
| },
|
| @@ -1504,14 +1718,14 @@
|
| "$ref": "Http",
|
| "description": "HTTP configuration."
|
| },
|
| - "backend": {
|
| - "$ref": "Backend",
|
| - "description": "API backend configuration."
|
| - },
|
| "systemParameters": {
|
| "$ref": "SystemParameters",
|
| "description": "System parameter configuration."
|
| },
|
| + "backend": {
|
| + "$ref": "Backend",
|
| + "description": "API backend configuration."
|
| + },
|
| "documentation": {
|
| "$ref": "Documentation",
|
| "description": "Additional API documentation."
|
| @@ -1527,6 +1741,10 @@
|
| },
|
| "type": "array"
|
| },
|
| + "context": {
|
| + "$ref": "Context",
|
| + "description": "Context configuration."
|
| + },
|
| "enums": {
|
| "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
|
| "items": {
|
| @@ -1534,10 +1752,6 @@
|
| },
|
| "type": "array"
|
| },
|
| - "context": {
|
| - "$ref": "Context",
|
| - "description": "Context configuration."
|
| - },
|
| "id": {
|
| "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
|
| "type": "string"
|
| @@ -1560,15 +1774,6 @@
|
| "experimental": {
|
| "$ref": "Experimental",
|
| "description": "Experimental configuration."
|
| - },
|
| - "control": {
|
| - "$ref": "Control",
|
| - "description": "Configuration for the service control plane."
|
| - },
|
| - "configVersion": {
|
| - "description": "The version of the service configuration. The config version may\ninfluence interpretation of the configuration, for example, to\ndetermine defaults. This is documented together with applicable\noptions. The current default for the config version itself is `3`.",
|
| - "format": "uint32",
|
| - "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1577,6 +1782,11 @@
|
| "description": "Enum value definition.",
|
| "id": "EnumValue",
|
| "properties": {
|
| + "number": {
|
| + "description": "Enum value number.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| "name": {
|
| "description": "Enum value name.",
|
| "type": "string"
|
| @@ -1587,11 +1797,6 @@
|
| "$ref": "Option"
|
| },
|
| "type": "array"
|
| - },
|
| - "number": {
|
| - "description": "Enum value number.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1600,16 +1805,47 @@
|
| "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"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "The standard List next-page token.",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "OperationMetadata": {
|
| + "description": "The metadata associated with a long running operation resource.",
|
| + "id": "OperationMetadata",
|
| + "properties": {
|
| + "startTime": {
|
| + "description": "The start time of the operation.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| + },
|
| + "steps": {
|
| + "description": "Detailed status information for each step. The order is undetermined.",
|
| + "items": {
|
| + "$ref": "Step"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "resourceNames": {
|
| + "description": "The full name of the resources that this operation is directly\nassociated with.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "progressPercentage": {
|
| + "description": "Percentage of completion of this operation, ranging from 0 to 100.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1629,50 +1865,34 @@
|
| },
|
| "type": "object"
|
| },
|
| - "OperationMetadata": {
|
| - "description": "The metadata associated with a long running operation resource.",
|
| - "id": "OperationMetadata",
|
| + "SystemParameterRule": {
|
| + "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
|
| + "id": "SystemParameterRule",
|
| "properties": {
|
| - "progressPercentage": {
|
| - "description": "Percentage of completion of this operation, ranging from 0 to 100.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "startTime": {
|
| - "description": "The start time of the operation.",
|
| - "format": "google-datetime",
|
| + "selector": {
|
| + "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
|
| "type": "string"
|
| },
|
| - "resourceNames": {
|
| - "description": "The full name of the resources that this operation is directly\nassociated with.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "steps": {
|
| - "description": "Detailed status information for each step. The order is undetermined.",
|
| + "parameters": {
|
| + "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
|
| "items": {
|
| - "$ref": "Step"
|
| + "$ref": "SystemParameter"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SystemParameterRule": {
|
| - "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
|
| - "id": "SystemParameterRule",
|
| + "VisibilityRule": {
|
| + "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
|
| + "id": "VisibilityRule",
|
| "properties": {
|
| - "parameters": {
|
| - "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
|
| - "items": {
|
| - "$ref": "SystemParameter"
|
| - },
|
| - "type": "array"
|
| + "restriction": {
|
| + "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
|
| + "type": "string"
|
| },
|
| "selector": {
|
| - "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
|
| + "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
|
| "type": "string"
|
| }
|
| },
|
| @@ -1682,18 +1902,6 @@
|
| "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: <proto_package_name>.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
|
| "id": "HttpRule",
|
| "properties": {
|
| - "get": {
|
| - "description": "Used for listing and getting information about resources.",
|
| - "type": "string"
|
| - },
|
| - "patch": {
|
| - "description": "Used for updating a resource.",
|
| - "type": "string"
|
| - },
|
| - "put": {
|
| - "description": "Used for updating a resource.",
|
| - "type": "string"
|
| - },
|
| "delete": {
|
| "description": "Used for deleting a resource.",
|
| "type": "string"
|
| @@ -1702,14 +1910,14 @@
|
| "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
|
| "type": "string"
|
| },
|
| - "post": {
|
| - "description": "Used for creating a resource.",
|
| - "type": "string"
|
| - },
|
| "mediaDownload": {
|
| "$ref": "MediaDownload",
|
| "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
|
| },
|
| + "post": {
|
| + "description": "Used for creating a resource.",
|
| + "type": "string"
|
| + },
|
| "restMethodName": {
|
| "description": "Optional. The rest method name is by default derived from the URL\npattern. If specified, this field overrides the default method name.\nExample:\n\n rpc CreateResource(CreateResourceRequest)\n returns (CreateResourceResponse) {\n option (google.api.http) = {\n post: \"/v1/resources\",\n body: \"resource\",\n rest_method_name: \"insert\"\n };\n }\n\nThis method has the automatically derived rest method name \"create\", but\n for backwards compatability with apiary, it is specified as insert.",
|
| "type": "string"
|
| @@ -1740,20 +1948,17 @@
|
| "custom": {
|
| "$ref": "CustomHttpPattern",
|
| "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "VisibilityRule": {
|
| - "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
|
| - "id": "VisibilityRule",
|
| - "properties": {
|
| - "restriction": {
|
| - "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
|
| + },
|
| + "patch": {
|
| + "description": "Used for updating a resource.",
|
| "type": "string"
|
| },
|
| - "selector": {
|
| - "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "get": {
|
| + "description": "Used for listing and getting information about resources.",
|
| + "type": "string"
|
| + },
|
| + "put": {
|
| + "description": "Used for updating a resource.",
|
| "type": "string"
|
| }
|
| },
|
| @@ -1809,6 +2014,21 @@
|
| "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility.",
|
| "id": "ConfigChange",
|
| "properties": {
|
| + "element": {
|
| + "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]",
|
| + "type": "string"
|
| + },
|
| + "advices": {
|
| + "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.",
|
| + "items": {
|
| + "$ref": "Advice"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "oldValue": {
|
| + "description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.",
|
| + "type": "string"
|
| + },
|
| "newValue": {
|
| "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
|
| "type": "string"
|
| @@ -1828,21 +2048,6 @@
|
| "The changed object exists in both service configurations, but its value\nis different."
|
| ],
|
| "type": "string"
|
| - },
|
| - "element": {
|
| - "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]",
|
| - "type": "string"
|
| - },
|
| - "oldValue": {
|
| - "description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.",
|
| - "type": "string"
|
| - },
|
| - "advices": {
|
| - "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.",
|
| - "items": {
|
| - "$ref": "Advice"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1872,26 +2077,6 @@
|
| "description": "A rollout resource that defines how service configuration versions are pushed\nto control plane systems. Typically, you create a new version of the\nservice config, and then create a Rollout to push the service config.",
|
| "id": "Rollout",
|
| "properties": {
|
| - "serviceName": {
|
| - "description": "The name of the service associated with this Rollout.",
|
| - "type": "string"
|
| - },
|
| - "trafficPercentStrategy": {
|
| - "$ref": "TrafficPercentStrategy",
|
| - "description": "Google Service Control selects service configurations based on\ntraffic percentage."
|
| - },
|
| - "createdBy": {
|
| - "description": "The user who created the Rollout. Readonly.",
|
| - "type": "string"
|
| - },
|
| - "rolloutId": {
|
| - "description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of <date><revision number>, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'",
|
| - "type": "string"
|
| - },
|
| - "deleteServiceStrategy": {
|
| - "$ref": "DeleteServiceStrategy",
|
| - "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly."
|
| - },
|
| "createTime": {
|
| "description": "Creation time of the rollout. Readonly.",
|
| "format": "google-datetime",
|
| @@ -1918,6 +2103,26 @@
|
| "The Rollout has failed and rolled back to the previous successful\nRollout."
|
| ],
|
| "type": "string"
|
| + },
|
| + "serviceName": {
|
| + "description": "The name of the service associated with this Rollout.",
|
| + "type": "string"
|
| + },
|
| + "trafficPercentStrategy": {
|
| + "$ref": "TrafficPercentStrategy",
|
| + "description": "Google Service Control selects service configurations based on\ntraffic percentage."
|
| + },
|
| + "createdBy": {
|
| + "description": "The user who created the Rollout. Readonly.",
|
| + "type": "string"
|
| + },
|
| + "rolloutId": {
|
| + "description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of <date><revision number>, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'",
|
| + "type": "string"
|
| + },
|
| + "deleteServiceStrategy": {
|
| + "$ref": "DeleteServiceStrategy",
|
| + "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1949,14 +2154,14 @@
|
| "description": "Request message for `SetIamPolicy` method.",
|
| "id": "SetIamPolicyRequest",
|
| "properties": {
|
| + "policy": {
|
| + "$ref": "Policy",
|
| + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
|
| + },
|
| "updateMask": {
|
| "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
|
| "format": "google-fieldmask",
|
| "type": "string"
|
| - },
|
| - "policy": {
|
| - "$ref": "Policy",
|
| - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
|
| }
|
| },
|
| "type": "object"
|
| @@ -1971,6 +2176,10 @@
|
| "description": "Represents the status of one operation step.",
|
| "id": "Step",
|
| "properties": {
|
| + "description": {
|
| + "description": "The short description of the step.",
|
| + "type": "string"
|
| + },
|
| "status": {
|
| "description": "The status code.",
|
| "enum": [
|
| @@ -1990,10 +2199,6 @@
|
| "The operation or step has completed with cancellation."
|
| ],
|
| "type": "string"
|
| - },
|
| - "description": {
|
| - "description": "The short description of the step.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2020,96 +2225,42 @@
|
| "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
|
| "id": "Option",
|
| "properties": {
|
| - "value": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
|
| - "type": "object"
|
| - },
|
| "name": {
|
| "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Logging": {
|
| - "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
|
| - "id": "Logging",
|
| - "properties": {
|
| - "consumerDestinations": {
|
| - "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
|
| - "items": {
|
| - "$ref": "LoggingDestination"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "producerDestinations": {
|
| - "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
|
| - "items": {
|
| - "$ref": "LoggingDestination"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "QuotaLimit": {
|
| - "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
|
| - "id": "QuotaLimit",
|
| - "properties": {
|
| - "unit": {
|
| - "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com/service-control)\nsupports the following unit components:\n* One of the time intevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 hours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUsed by metric-based quotas only.",
|
| - "type": "string"
|
| - },
|
| - "maxLimit": {
|
| - "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
|
| - "format": "int64",
|
| - "type": "string"
|
| },
|
| - "name": {
|
| - "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
|
| - "type": "string"
|
| - },
|
| - "duration": {
|
| - "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
|
| - "type": "string"
|
| - },
|
| - "freeTier": {
|
| - "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "defaultLimit": {
|
| - "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "description": {
|
| - "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
|
| - "type": "string"
|
| - },
|
| - "metric": {
|
| - "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.\n\nUsed by metric-based quotas only.",
|
| - "type": "string"
|
| - },
|
| - "displayName": {
|
| - "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
|
| - "type": "string"
|
| - },
|
| - "values": {
|
| + "value": {
|
| "additionalProperties": {
|
| - "format": "int64",
|
| - "type": "string"
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| },
|
| - "description": "Tiered limit values, currently only STANDARD is supported.",
|
| + "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
|
| "type": "object"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| + "Logging": {
|
| + "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
|
| + "id": "Logging",
|
| + "properties": {
|
| + "consumerDestinations": {
|
| + "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
|
| + "items": {
|
| + "$ref": "LoggingDestination"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "producerDestinations": {
|
| + "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
|
| + "items": {
|
| + "$ref": "LoggingDestination"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "Method": {
|
| "description": "Method represents a method of an api.",
|
| "id": "Method",
|
| @@ -2156,19 +2307,55 @@
|
| },
|
| "type": "object"
|
| },
|
| - "ListServiceRolloutsResponse": {
|
| - "description": "Response message for ListServiceRollouts method.",
|
| - "id": "ListServiceRolloutsResponse",
|
| + "QuotaLimit": {
|
| + "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
|
| + "id": "QuotaLimit",
|
| "properties": {
|
| - "rollouts": {
|
| - "description": "The list of rollout resources.",
|
| - "items": {
|
| - "$ref": "Rollout"
|
| + "duration": {
|
| + "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
|
| + "type": "string"
|
| + },
|
| + "freeTier": {
|
| + "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "defaultLimit": {
|
| + "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "displayName": {
|
| + "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
|
| + "type": "string"
|
| + },
|
| + "description": {
|
| + "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
|
| + "type": "string"
|
| + },
|
| + "metric": {
|
| + "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.\n\nUsed by metric-based quotas only.",
|
| + "type": "string"
|
| + },
|
| + "values": {
|
| + "additionalProperties": {
|
| + "format": "int64",
|
| + "type": "string"
|
| },
|
| - "type": "array"
|
| + "description": "Tiered limit values, currently only STANDARD is supported.",
|
| + "type": "object"
|
| },
|
| - "nextPageToken": {
|
| - "description": "The token of the next page of results.",
|
| + "unit": {
|
| + "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com/service-control)\nsupports the following unit components:\n* One of the time intevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 hours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUsed by metric-based quotas only.",
|
| + "type": "string"
|
| + },
|
| + "maxLimit": {
|
| + "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "name": {
|
| + "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
|
| "type": "string"
|
| }
|
| },
|
| @@ -2185,6 +2372,24 @@
|
| },
|
| "type": "object"
|
| },
|
| + "ListServiceRolloutsResponse": {
|
| + "description": "Response message for ListServiceRollouts method.",
|
| + "id": "ListServiceRolloutsResponse",
|
| + "properties": {
|
| + "nextPageToken": {
|
| + "description": "The token of the next page of results.",
|
| + "type": "string"
|
| + },
|
| + "rollouts": {
|
| + "description": "The list of rollout resources.",
|
| + "items": {
|
| + "$ref": "Rollout"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "Mixin": {
|
| "description": "Declares an API to be included in this API. The including API must\nredeclare all the methods from the included API, but documentation\nand options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including API plus the root path if specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
|
| "id": "Mixin",
|
| @@ -2204,6 +2409,22 @@
|
| "description": "The metadata associated with a long running operation resource.",
|
| "id": "FlowOperationMetadata",
|
| "properties": {
|
| + "resourceNames": {
|
| + "description": "The full name of the resources that this flow is directly associated with.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "flowName": {
|
| + "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum.",
|
| + "type": "string"
|
| + },
|
| + "deadline": {
|
| + "description": "Deadline for the flow to complete, to prevent orphaned Operations.\n\nIf the flow has not completed by this time, it may be terminated by\nthe engine, or force-failed by Operation lookup.\n\nNote that this is not a hard deadline after which the Flow will\ndefinitely be failed, rather it is a deadline after which it is reasonable\nto suspect a problem and other parts of the system may kill operation\nto ensure we don't have orphans.\nsee also: go/prevent-orphaned-operations",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + },
|
| "cancelState": {
|
| "description": "The state of the operation with respect to cancellation.",
|
| "enum": [
|
| @@ -2218,26 +2439,10 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "deadline": {
|
| - "description": "Deadline for the flow to complete, to prevent orphaned Operations.\n\nIf the flow has not completed by this time, it may be terminated by\nthe engine, or force-failed by Operation lookup.\n\nNote that this is not a hard deadline after which the Flow will\ndefinitely be failed, rather it is a deadline after which it is reasonable\nto suspect a problem and other parts of the system may kill operation\nto ensure we don't have orphans.\nsee also: go/prevent-orphaned-operations",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| "startTime": {
|
| "description": "The start time of the operation.",
|
| "format": "google-datetime",
|
| "type": "string"
|
| - },
|
| - "flowName": {
|
| - "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum.",
|
| - "type": "string"
|
| - },
|
| - "resourceNames": {
|
| - "description": "The full name of the resources that this flow is directly associated with.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2267,13 +2472,13 @@
|
| "description": "Options for counters",
|
| "id": "CounterOptions",
|
| "properties": {
|
| - "metric": {
|
| - "description": "The metric to update.",
|
| - "type": "string"
|
| - },
|
| "field": {
|
| "description": "The field value to attribute.",
|
| "type": "string"
|
| + },
|
| + "metric": {
|
| + "description": "The metric to update.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2282,16 +2487,16 @@
|
| "description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
|
| "id": "Http",
|
| "properties": {
|
| + "fullyDecodeReservedExpansion": {
|
| + "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
|
| + "type": "boolean"
|
| + },
|
| "rules": {
|
| "description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| "$ref": "HttpRule"
|
| },
|
| "type": "array"
|
| - },
|
| - "fullyDecodeReservedExpansion": {
|
| - "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
|
| - "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2344,40 +2549,14 @@
|
| },
|
| "type": "object"
|
| },
|
| - "Monitoring": {
|
| - "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
|
| - "id": "Monitoring",
|
| - "properties": {
|
| - "consumerDestinations": {
|
| - "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
|
| - "items": {
|
| - "$ref": "MonitoringDestination"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "producerDestinations": {
|
| - "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
|
| - "items": {
|
| - "$ref": "MonitoringDestination"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "Field": {
|
| "description": "A single field of a message type.",
|
| "id": "Field",
|
| "properties": {
|
| - "typeUrl": {
|
| - "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
|
| + "jsonName": {
|
| + "description": "The field JSON name.",
|
| "type": "string"
|
| },
|
| - "number": {
|
| - "description": "The field number.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| "kind": {
|
| "description": "The field type.",
|
| "enum": [
|
| @@ -2424,10 +2603,6 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "jsonName": {
|
| - "description": "The field JSON name.",
|
| - "type": "string"
|
| - },
|
| "options": {
|
| "description": "The protocol buffer options.",
|
| "items": {
|
| @@ -2440,6 +2615,10 @@
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| + "packed": {
|
| + "description": "Whether to use alternative packed wire representation.",
|
| + "type": "boolean"
|
| + },
|
| "cardinality": {
|
| "description": "The field cardinality.",
|
| "enum": [
|
| @@ -2456,10 +2635,6 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "packed": {
|
| - "description": "Whether to use alternative packed wire representation.",
|
| - "type": "boolean"
|
| - },
|
| "defaultValue": {
|
| "description": "The string value of the default value of this field. Proto2 syntax only.",
|
| "type": "string"
|
| @@ -2467,6 +2642,36 @@
|
| "name": {
|
| "description": "The field name.",
|
| "type": "string"
|
| + },
|
| + "typeUrl": {
|
| + "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
|
| + "type": "string"
|
| + },
|
| + "number": {
|
| + "description": "The field number.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Monitoring": {
|
| + "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
|
| + "id": "Monitoring",
|
| + "properties": {
|
| + "consumerDestinations": {
|
| + "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
|
| + "items": {
|
| + "$ref": "MonitoringDestination"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "producerDestinations": {
|
| + "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
|
| + "items": {
|
| + "$ref": "MonitoringDestination"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2489,10 +2694,6 @@
|
| "description": "Enum type definition.",
|
| "id": "Enum",
|
| "properties": {
|
| - "name": {
|
| - "description": "Enum type name.",
|
| - "type": "string"
|
| - },
|
| "enumvalue": {
|
| "description": "Enum value definitions.",
|
| "items": {
|
| @@ -2500,6 +2701,10 @@
|
| },
|
| "type": "array"
|
| },
|
| + "name": {
|
| + "description": "Enum type name.",
|
| + "type": "string"
|
| + },
|
| "options": {
|
| "description": "Protocol buffer options.",
|
| "items": {
|
| @@ -2507,10 +2712,6 @@
|
| },
|
| "type": "array"
|
| },
|
| - "sourceContext": {
|
| - "$ref": "SourceContext",
|
| - "description": "The source context."
|
| - },
|
| "syntax": {
|
| "description": "The source syntax.",
|
| "enum": [
|
| @@ -2522,16 +2723,38 @@
|
| "Syntax `proto3`."
|
| ],
|
| "type": "string"
|
| + },
|
| + "sourceContext": {
|
| + "$ref": "SourceContext",
|
| + "description": "The source context."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "EnableServiceRequest": {
|
| - "description": "Request message for EnableService method.",
|
| - "id": "EnableServiceRequest",
|
| + "LabelDescriptor": {
|
| + "description": "A description of a label.",
|
| + "id": "LabelDescriptor",
|
| "properties": {
|
| - "consumerId": {
|
| - "description": "The identity of consumer resource which service enablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
|
| + "description": {
|
| + "description": "A human-readable description for the label.",
|
| + "type": "string"
|
| + },
|
| + "valueType": {
|
| + "description": "The type of data that can be assigned to the label.",
|
| + "enum": [
|
| + "STRING",
|
| + "BOOL",
|
| + "INT64"
|
| + ],
|
| + "enumDescriptions": [
|
| + "A variable-length string. This is the default.",
|
| + "Boolean; true or false.",
|
| + "A 64-bit signed integer."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "key": {
|
| + "description": "The label key.",
|
| "type": "string"
|
| }
|
| },
|
| @@ -2541,10 +2764,6 @@
|
| "description": "Represents a diagnostic message (error or warning)",
|
| "id": "Diagnostic",
|
| "properties": {
|
| - "location": {
|
| - "description": "File name and line number of the error or warning.",
|
| - "type": "string"
|
| - },
|
| "kind": {
|
| "description": "The kind of diagnostic information provided.",
|
| "enum": [
|
| @@ -2560,34 +2779,20 @@
|
| "message": {
|
| "description": "Message describing the error or warning.",
|
| "type": "string"
|
| + },
|
| + "location": {
|
| + "description": "File name and line number of the error or warning.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "LabelDescriptor": {
|
| - "description": "A description of a label.",
|
| - "id": "LabelDescriptor",
|
| + "EnableServiceRequest": {
|
| + "description": "Request message for EnableService method.",
|
| + "id": "EnableServiceRequest",
|
| "properties": {
|
| - "key": {
|
| - "description": "The label key.",
|
| - "type": "string"
|
| - },
|
| - "description": {
|
| - "description": "A human-readable description for the label.",
|
| - "type": "string"
|
| - },
|
| - "valueType": {
|
| - "description": "The type of data that can be assigned to the label.",
|
| - "enum": [
|
| - "STRING",
|
| - "BOOL",
|
| - "INT64"
|
| - ],
|
| - "enumDescriptions": [
|
| - "A variable-length string. This is the default.",
|
| - "Boolean; true or false.",
|
| - "A 64-bit signed integer."
|
| - ],
|
| + "consumerId": {
|
| + "description": "The identity of consumer resource which service enablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
|
| "type": "string"
|
| }
|
| },
|
| @@ -2622,6 +2827,10 @@
|
| },
|
| "type": "array"
|
| },
|
| + "sourceContext": {
|
| + "$ref": "SourceContext",
|
| + "description": "The source context."
|
| + },
|
| "syntax": {
|
| "description": "The source syntax.",
|
| "enum": [
|
| @@ -2633,10 +2842,6 @@
|
| "Syntax `proto3`."
|
| ],
|
| "type": "string"
|
| - },
|
| - "sourceContext": {
|
| - "$ref": "SourceContext",
|
| - "description": "The source context."
|
| }
|
| },
|
| "type": "object"
|
| @@ -2645,13 +2850,6 @@
|
| "description": "Response message for GenerateConfigReport method.",
|
| "id": "GenerateConfigReportResponse",
|
| "properties": {
|
| - "diagnostics": {
|
| - "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
|
| - "items": {
|
| - "$ref": "Diagnostic"
|
| - },
|
| - "type": "array"
|
| - },
|
| "serviceName": {
|
| "description": "Name of the service this report belongs to.",
|
| "type": "string"
|
| @@ -2666,6 +2864,13 @@
|
| "id": {
|
| "description": "ID of the service configuration this report belongs to.",
|
| "type": "string"
|
| + },
|
| + "diagnostics": {
|
| + "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
|
| + "items": {
|
| + "$ref": "Diagnostic"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2699,24 +2904,16 @@
|
| },
|
| "type": "object"
|
| },
|
| - "Backend": {
|
| - "description": "`Backend` defines the backend configuration for a service.",
|
| - "id": "Backend",
|
| - "properties": {
|
| - "rules": {
|
| - "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| - "items": {
|
| - "$ref": "BackendRule"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| "AuditConfig": {
|
| "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
| "id": "AuditConfig",
|
| "properties": {
|
| + "exemptedMembers": {
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| "service": {
|
| "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
|
| "type": "string"
|
| @@ -2727,10 +2924,18 @@
|
| "$ref": "AuditLogConfig"
|
| },
|
| "type": "array"
|
| - },
|
| - "exemptedMembers": {
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Backend": {
|
| + "description": "`Backend` defines the backend configuration for a service.",
|
| + "id": "Backend",
|
| + "properties": {
|
| + "rules": {
|
| + "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "BackendRule"
|
| },
|
| "type": "array"
|
| }
|
| @@ -2741,32 +2946,13 @@
|
| "description": "Request message for SubmitConfigSource method.",
|
| "id": "SubmitConfigSourceRequest",
|
| "properties": {
|
| - "validateOnly": {
|
| - "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.",
|
| - "type": "boolean"
|
| - },
|
| "configSource": {
|
| "$ref": "ConfigSource",
|
| "description": "The source configuration for the service."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "DocumentationRule": {
|
| - "description": "A documentation rule provides information about individual API elements.",
|
| - "id": "DocumentationRule",
|
| - "properties": {
|
| - "deprecationDescription": {
|
| - "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
|
| - "type": "string"
|
| - },
|
| - "selector": {
|
| - "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
|
| - "type": "string"
|
| },
|
| - "description": {
|
| - "description": "Description of the selected API(s).",
|
| - "type": "string"
|
| + "validateOnly": {
|
| + "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2782,26 +2968,20 @@
|
| },
|
| "type": "object"
|
| },
|
| - "ContextRule": {
|
| - "description": "A context rule provides information about the context for an individual API\nelement.",
|
| - "id": "ContextRule",
|
| + "DocumentationRule": {
|
| + "description": "A documentation rule provides information about individual API elements.",
|
| + "id": "DocumentationRule",
|
| "properties": {
|
| - "provided": {
|
| - "description": "A list of full type names of provided contexts.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "description": {
|
| + "description": "Description of the selected API(s).",
|
| + "type": "string"
|
| },
|
| - "requested": {
|
| - "description": "A list of full type names of requested contexts.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "deprecationDescription": {
|
| + "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
|
| + "type": "string"
|
| },
|
| "selector": {
|
| - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
|
| "type": "string"
|
| }
|
| },
|
| @@ -2828,10 +3008,65 @@
|
| },
|
| "type": "object"
|
| },
|
| + "ContextRule": {
|
| + "description": "A context rule provides information about the context for an individual API\nelement.",
|
| + "id": "ContextRule",
|
| + "properties": {
|
| + "requested": {
|
| + "description": "A list of full type names of requested contexts.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "selector": {
|
| + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "type": "string"
|
| + },
|
| + "provided": {
|
| + "description": "A list of full type names of provided contexts.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "MetricDescriptor": {
|
| "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
|
| "id": "MetricDescriptor",
|
| "properties": {
|
| + "name": {
|
| + "description": "The resource name of the metric descriptor. Depending on the\nimplementation, the name typically includes: (1) the parent resource name\nthat defines the scope of the metric type or of its data; and (2) the\nmetric's URL-encoded type, which also appears in the `type` field of this\ndescriptor. For example, following is the resource name of a custom\nmetric within the GCP project `my-project-id`:\n\n \"projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"",
|
| + "type": "string"
|
| + },
|
| + "type": {
|
| + "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
|
| + "type": "string"
|
| + },
|
| + "valueType": {
|
| + "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
|
| + "enum": [
|
| + "VALUE_TYPE_UNSPECIFIED",
|
| + "BOOL",
|
| + "INT64",
|
| + "DOUBLE",
|
| + "STRING",
|
| + "DISTRIBUTION",
|
| + "MONEY"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Do not use this default value.",
|
| + "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
|
| + "The value is a signed 64-bit integer.",
|
| + "The value is a double precision floating point number.",
|
| + "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
|
| + "The value is a `Distribution`.",
|
| + "The value is money."
|
| + ],
|
| + "type": "string"
|
| + },
|
| "metricKind": {
|
| "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
|
| "enum": [
|
| @@ -2866,36 +3101,6 @@
|
| "$ref": "LabelDescriptor"
|
| },
|
| "type": "array"
|
| - },
|
| - "name": {
|
| - "description": "The resource name of the metric descriptor. Depending on the\nimplementation, the name typically includes: (1) the parent resource name\nthat defines the scope of the metric type or of its data; and (2) the\nmetric's URL-encoded type, which also appears in the `type` field of this\ndescriptor. For example, following is the resource name of a custom\nmetric within the GCP project `my-project-id`:\n\n \"projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"",
|
| - "type": "string"
|
| - },
|
| - "type": {
|
| - "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
|
| - "type": "string"
|
| - },
|
| - "valueType": {
|
| - "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
|
| - "enum": [
|
| - "VALUE_TYPE_UNSPECIFIED",
|
| - "BOOL",
|
| - "INT64",
|
| - "DOUBLE",
|
| - "STRING",
|
| - "DISTRIBUTION",
|
| - "MONEY"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Do not use this default value.",
|
| - "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
|
| - "The value is a signed 64-bit integer.",
|
| - "The value is a double precision floating point number.",
|
| - "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
|
| - "The value is a `Distribution`.",
|
| - "The value is money."
|
| - ],
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2920,16 +3125,16 @@
|
| "type": "string"
|
| },
|
| "expression": {
|
| - "description": "Textual representation of an expression in\n[Common Expression Language](http://go/api-expr) syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
| - "type": "string"
|
| - },
|
| - "title": {
|
| - "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
| + "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
| "type": "string"
|
| },
|
| "location": {
|
| "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
| "type": "string"
|
| + },
|
| + "title": {
|
| + "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2938,16 +3143,16 @@
|
| "description": "Response message for `ListServices` method.",
|
| "id": "ListServicesResponse",
|
| "properties": {
|
| - "services": {
|
| - "description": "The returned services will only have the name field set.",
|
| - "items": {
|
| - "$ref": "ManagedService"
|
| - },
|
| - "type": "array"
|
| - },
|
| "nextPageToken": {
|
| "description": "Token that can be passed to `ListServices` to resume a paginated query.",
|
| "type": "string"
|
| + },
|
| + "services": {
|
| + "description": "The returned services will only have the name field set.",
|
| + "items": {
|
| + "$ref": "ManagedService"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -2956,13 +3161,6 @@
|
| "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
|
| "id": "Endpoint",
|
| "properties": {
|
| - "features": {
|
| - "description": "The list of features enabled on this endpoint.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| "apis": {
|
| "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration.",
|
| "items": {
|
| @@ -2981,13 +3179,20 @@
|
| },
|
| "type": "array"
|
| },
|
| + "name": {
|
| + "description": "The canonical name of this endpoint.",
|
| + "type": "string"
|
| + },
|
| "target": {
|
| "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
|
| "type": "string"
|
| },
|
| - "name": {
|
| - "description": "The canonical name of this endpoint.",
|
| - "type": "string"
|
| + "features": {
|
| + "description": "The list of features enabled on this endpoint.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3027,13 +3232,6 @@
|
| "description": "Configuration controlling usage of a service.",
|
| "id": "Usage",
|
| "properties": {
|
| - "requirements": {
|
| - "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form <service.name>/<requirement-id>;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| "producerNotificationChannel": {
|
| "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
|
| "type": "string"
|
| @@ -3044,6 +3242,13 @@
|
| "$ref": "UsageRule"
|
| },
|
| "type": "array"
|
| + },
|
| + "requirements": {
|
| + "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form <service.name>/<requirement-id>;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| @@ -3066,13 +3271,6 @@
|
| "description": "A rule to be applied in a Policy.",
|
| "id": "Rule",
|
| "properties": {
|
| - "permissions": {
|
| - "description": "A permission is a string of form '<service>.<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| "action": {
|
| "description": "Required",
|
| "enum": [
|
| @@ -3124,12 +3322,19 @@
|
| "type": "string"
|
| },
|
| "type": "array"
|
| + },
|
| + "permissions": {
|
| + "description": "A permission is a string of form '<service>.<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| "LogConfig": {
|
| - "description": "Specifies what kind of log the caller must write",
|
| + "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
|
| "id": "LogConfig",
|
| "properties": {
|
| "cloudAudit": {
|
| @@ -3151,225 +3356,24 @@
|
| "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
|
| "id": "LogDescriptor",
|
| "properties": {
|
| - "labels": {
|
| - "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
|
| - "items": {
|
| - "$ref": "LabelDescriptor"
|
| - },
|
| - "type": "array"
|
| - },
|
| "name": {
|
| "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
|
| "type": "string"
|
| },
|
| - "description": {
|
| - "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
|
| - "type": "string"
|
| - },
|
| "displayName": {
|
| "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ConfigFile": {
|
| - "description": "Generic specification of a source configuration file",
|
| - "id": "ConfigFile",
|
| - "properties": {
|
| - "filePath": {
|
| - "description": "The file name of the configuration file (full or relative path).",
|
| - "type": "string"
|
| - },
|
| - "fileType": {
|
| - "description": "The type of configuration file this represents.",
|
| - "enum": [
|
| - "FILE_TYPE_UNSPECIFIED",
|
| - "SERVICE_CONFIG_YAML",
|
| - "OPEN_API_JSON",
|
| - "OPEN_API_YAML",
|
| - "FILE_DESCRIPTOR_SET_PROTO"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unknown file type.",
|
| - "YAML-specification of service.",
|
| - "OpenAPI specification, serialized in JSON.",
|
| - "OpenAPI specification, serialized in YAML.",
|
| - "FileDescriptorSet, generated by protoc.\n\nTo generate, use protoc with imports and source info included.\nFor an example test.proto file, the following command would put the value\nin a new file named out.pb.\n\n$protoc --include_imports --include_source_info test.proto -o out.pb"
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "fileContents": {
|
| - "description": "The bytes that constitute the file.",
|
| - "format": "byte",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "MonitoredResourceDescriptor": {
|
| - "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
|
| - "id": "MonitoredResourceDescriptor",
|
| - "properties": {
|
| - "displayName": {
|
| - "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
|
| - "type": "string"
|
| },
|
| "description": {
|
| - "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
|
| - "type": "string"
|
| - },
|
| - "type": {
|
| - "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
|
| + "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
|
| "type": "string"
|
| },
|
| "labels": {
|
| - "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
|
| + "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
|
| "items": {
|
| "$ref": "LabelDescriptor"
|
| },
|
| "type": "array"
|
| - },
|
| - "name": {
|
| - "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "CustomErrorRule": {
|
| - "description": "A custom error rule.",
|
| - "id": "CustomErrorRule",
|
| - "properties": {
|
| - "isErrorType": {
|
| - "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
|
| - "type": "boolean"
|
| - },
|
| - "selector": {
|
| - "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "MediaDownload": {
|
| - "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
|
| - "id": "MediaDownload",
|
| - "properties": {
|
| - "enabled": {
|
| - "description": "Whether download is enabled.",
|
| - "type": "boolean"
|
| - },
|
| - "downloadService": {
|
| - "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
|
| - "type": "string"
|
| - },
|
| - "completeNotification": {
|
| - "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
|
| - "type": "boolean"
|
| - },
|
| - "dropzone": {
|
| - "description": "Name of the Scotty dropzone to use for the current API.",
|
| - "type": "string"
|
| - },
|
| - "maxDirectDownloadSize": {
|
| - "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "useDirectDownload": {
|
| - "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
|
| - "type": "boolean"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "CustomAuthRequirements": {
|
| - "description": "Configuration for a custom authentication provider.",
|
| - "id": "CustomAuthRequirements",
|
| - "properties": {
|
| - "provider": {
|
| - "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ChangeReport": {
|
| - "description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.",
|
| - "id": "ChangeReport",
|
| - "properties": {
|
| - "configChanges": {
|
| - "description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction",
|
| - "items": {
|
| - "$ref": "ConfigChange"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "DisableServiceRequest": {
|
| - "description": "Request message for DisableService method.",
|
| - "id": "DisableServiceRequest",
|
| - "properties": {
|
| - "consumerId": {
|
| - "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:<project_id>\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "SubmitConfigSourceResponse": {
|
| - "description": "Response message for SubmitConfigSource method.",
|
| - "id": "SubmitConfigSourceResponse",
|
| - "properties": {
|
| - "serviceConfig": {
|
| - "$ref": "Service",
|
| - "description": "The generated service configuration."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "MediaUpload": {
|
| - "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
|
| - "id": "MediaUpload",
|
| - "properties": {
|
| - "dropzone": {
|
| - "description": "Name of the Scotty dropzone to use for the current API.",
|
| - "type": "string"
|
| - },
|
| - "startNotification": {
|
| - "description": "Whether to receive a notification on the start of media upload.",
|
| - "type": "boolean"
|
| - },
|
| - "uploadService": {
|
| - "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
|
| - "type": "string"
|
| - },
|
| - "maxSize": {
|
| - "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
|
| - "format": "int64",
|
| - "type": "string"
|
| - },
|
| - "mimeTypes": {
|
| - "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "enabled": {
|
| - "description": "Whether upload is enabled.",
|
| - "type": "boolean"
|
| - },
|
| - "progressNotification": {
|
| - "description": "Whether to receive a notification for progress changes of media upload.",
|
| - "type": "boolean"
|
| - },
|
| - "completeNotification": {
|
| - "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
|
| - "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
|
|
Chromium Code Reviews
Issue 2973303002:
Api-Roll 51: 2017-07-10 (Closed)
