OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/cloud-platform.read-only": { | 8 "https://www.googleapis.com/auth/cloud-platform.read-only": { |
9 "description": "View your data across Google Cloud Platform
services" | 9 "description": "View your data across Google Cloud Platform
services" |
10 }, | 10 }, |
(...skipping 105 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
116 "type": "string" | 116 "type": "string" |
117 }, | 117 }, |
118 "upload_protocol": { | 118 "upload_protocol": { |
119 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 119 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
120 "location": "query", | 120 "location": "query", |
121 "type": "string" | 121 "type": "string" |
122 } | 122 } |
123 }, | 123 }, |
124 "protocol": "rest", | 124 "protocol": "rest", |
125 "resources": { | 125 "resources": { |
| 126 "operations": { |
| 127 "methods": { |
| 128 "get": { |
| 129 "description": "Gets the latest state of a long-running oper
ation. Clients can use this\nmethod to poll the operation result at intervals a
s recommended by the API\nservice.", |
| 130 "httpMethod": "GET", |
| 131 "id": "servicemanagement.operations.get", |
| 132 "parameterOrder": [ |
| 133 "name" |
| 134 ], |
| 135 "parameters": { |
| 136 "name": { |
| 137 "description": "The name of the operation resource."
, |
| 138 "location": "path", |
| 139 "pattern": "^operations/.+$", |
| 140 "required": true, |
| 141 "type": "string" |
| 142 } |
| 143 }, |
| 144 "path": "v1/{+name}", |
| 145 "response": { |
| 146 "$ref": "Operation" |
| 147 }, |
| 148 "scopes": [ |
| 149 "https://www.googleapis.com/auth/cloud-platform", |
| 150 "https://www.googleapis.com/auth/service.management" |
| 151 ] |
| 152 } |
| 153 } |
| 154 }, |
126 "services": { | 155 "services": { |
127 "methods": { | 156 "methods": { |
128 "getIamPolicy": { | 157 "getIamPolicy": { |
129 "description": "Gets the access control policy for a resourc
e.\nReturns an empty policy if the resource exists and does not have a policy\ns
et.", | 158 "description": "Gets the access control policy for a resourc
e.\nReturns an empty policy if the resource exists and does not have a policy\ns
et.", |
130 "httpMethod": "POST", | 159 "httpMethod": "POST", |
131 "id": "servicemanagement.services.getIamPolicy", | 160 "id": "servicemanagement.services.getIamPolicy", |
132 "parameterOrder": [ | 161 "parameterOrder": [ |
133 "resource" | 162 "resource" |
134 ], | 163 ], |
135 "parameters": { | 164 "parameters": { |
(...skipping 157 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
293 }, | 322 }, |
294 "producerProjectId": { | 323 "producerProjectId": { |
295 "description": "Include services produced by the spe
cified project.", | 324 "description": "Include services produced by the spe
cified project.", |
296 "location": "query", | 325 "location": "query", |
297 "type": "string" | 326 "type": "string" |
298 }, | 327 }, |
299 "pageToken": { | 328 "pageToken": { |
300 "description": "Token identifying which result to st
art with; returned by a previous list\ncall.", | 329 "description": "Token identifying which result to st
art with; returned by a previous list\ncall.", |
301 "location": "query", | 330 "location": "query", |
302 "type": "string" | 331 "type": "string" |
| 332 }, |
| 333 "consumerId": { |
| 334 "description": "Include services consumed by the spe
cified consumer.\n\nThe Google Service Management implementation accepts the fol
lowing\nforms:\n- project:<project_id>", |
| 335 "location": "query", |
| 336 "type": "string" |
303 } | 337 } |
304 }, | 338 }, |
305 "path": "v1/services", | 339 "path": "v1/services", |
306 "response": { | 340 "response": { |
307 "$ref": "ListServicesResponse" | 341 "$ref": "ListServicesResponse" |
308 }, | 342 }, |
309 "scopes": [ | 343 "scopes": [ |
310 "https://www.googleapis.com/auth/cloud-platform", | 344 "https://www.googleapis.com/auth/cloud-platform", |
311 "https://www.googleapis.com/auth/cloud-platform.read-onl
y", | 345 "https://www.googleapis.com/auth/cloud-platform.read-onl
y", |
312 "https://www.googleapis.com/auth/service.management", | 346 "https://www.googleapis.com/auth/service.management", |
(...skipping 67 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
380 }, | 414 }, |
381 "response": { | 415 "response": { |
382 "$ref": "Policy" | 416 "$ref": "Policy" |
383 }, | 417 }, |
384 "scopes": [ | 418 "scopes": [ |
385 "https://www.googleapis.com/auth/cloud-platform", | 419 "https://www.googleapis.com/auth/cloud-platform", |
386 "https://www.googleapis.com/auth/service.management" | 420 "https://www.googleapis.com/auth/service.management" |
387 ] | 421 ] |
388 }, | 422 }, |
389 "delete": { | 423 "delete": { |
390 "description": "Deletes a managed service. This method will
change the serivce in the\n`Soft-Delete` state for 30 days. Within this period,
service producers may\ncall UndeleteService to restore the service.\nAfter 30 da
ys, the service will be permanently deleted.\n\nOperation<response: google.proto
buf.Empty>", | 424 "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 da
ys, the service will be permanently deleted.\n\nOperation<response: google.proto
buf.Empty>", |
391 "httpMethod": "DELETE", | 425 "httpMethod": "DELETE", |
392 "id": "servicemanagement.services.delete", | 426 "id": "servicemanagement.services.delete", |
393 "parameterOrder": [ | 427 "parameterOrder": [ |
394 "serviceName" | 428 "serviceName" |
395 ], | 429 ], |
396 "parameters": { | 430 "parameters": { |
397 "serviceName": { | 431 "serviceName": { |
398 "description": "The name of the service. See the [o
verview](/service-management/overview)\nfor naming requirements. For example: `
example.googleapis.com`.", | 432 "description": "The name of the service. See the [o
verview](/service-management/overview)\nfor naming requirements. For example: `
example.googleapis.com`.", |
399 "location": "path", | 433 "location": "path", |
400 "required": true, | 434 "required": true, |
401 "type": "string" | 435 "type": "string" |
402 } | 436 } |
403 }, | 437 }, |
404 "path": "v1/services/{serviceName}", | 438 "path": "v1/services/{serviceName}", |
405 "response": { | 439 "response": { |
406 "$ref": "Operation" | 440 "$ref": "Operation" |
407 }, | 441 }, |
408 "scopes": [ | 442 "scopes": [ |
409 "https://www.googleapis.com/auth/cloud-platform", | 443 "https://www.googleapis.com/auth/cloud-platform", |
410 "https://www.googleapis.com/auth/service.management" | 444 "https://www.googleapis.com/auth/service.management" |
411 ] | 445 ] |
412 }, | 446 }, |
413 "testIamPermissions": { | 447 "testIamPermissions": { |
414 "description": "Returns permissions that a caller has on the
specified resource.", | 448 "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.", |
415 "httpMethod": "POST", | 449 "httpMethod": "POST", |
416 "id": "servicemanagement.services.testIamPermissions", | 450 "id": "servicemanagement.services.testIamPermissions", |
417 "parameterOrder": [ | 451 "parameterOrder": [ |
418 "resource" | 452 "resource" |
419 ], | 453 ], |
420 "parameters": { | 454 "parameters": { |
421 "resource": { | 455 "resource": { |
422 "description": "REQUIRED: The resource for which the
policy detail is being requested.\n`resource` is usually specified as a path. F
or example, a Project\nresource is specified as `projects/{project}`.", | 456 "description": "REQUIRED: The resource for which the
policy detail is being requested.\n`resource` is usually specified as a path. F
or example, a Project\nresource is specified as `projects/{project}`.", |
423 "location": "path", | 457 "location": "path", |
424 "pattern": "^services/[^/]+$", | 458 "pattern": "^services/[^/]+$", |
(...skipping 238 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
663 "scopes": [ | 697 "scopes": [ |
664 "https://www.googleapis.com/auth/cloud-platform"
, | 698 "https://www.googleapis.com/auth/cloud-platform"
, |
665 "https://www.googleapis.com/auth/cloud-platform.
read-only", | 699 "https://www.googleapis.com/auth/cloud-platform.
read-only", |
666 "https://www.googleapis.com/auth/service.managem
ent", | 700 "https://www.googleapis.com/auth/service.managem
ent", |
667 "https://www.googleapis.com/auth/service.managem
ent.readonly" | 701 "https://www.googleapis.com/auth/service.managem
ent.readonly" |
668 ] | 702 ] |
669 } | 703 } |
670 } | 704 } |
671 } | 705 } |
672 } | 706 } |
673 }, | |
674 "operations": { | |
675 "methods": { | |
676 "get": { | |
677 "description": "Gets the latest state of a long-running oper
ation. Clients can use this\nmethod to poll the operation result at intervals a
s recommended by the API\nservice.", | |
678 "httpMethod": "GET", | |
679 "id": "servicemanagement.operations.get", | |
680 "parameterOrder": [ | |
681 "name" | |
682 ], | |
683 "parameters": { | |
684 "name": { | |
685 "description": "The name of the operation resource."
, | |
686 "location": "path", | |
687 "pattern": "^operations/.+$", | |
688 "required": true, | |
689 "type": "string" | |
690 } | |
691 }, | |
692 "path": "v1/{+name}", | |
693 "response": { | |
694 "$ref": "Operation" | |
695 }, | |
696 "scopes": [ | |
697 "https://www.googleapis.com/auth/cloud-platform", | |
698 "https://www.googleapis.com/auth/service.management" | |
699 ] | |
700 } | |
701 } | |
702 } | 707 } |
703 }, | 708 }, |
704 "revision": "20161102", | 709 "revision": "20161205", |
705 "rootUrl": "https://servicemanagement.googleapis.com/", | 710 "rootUrl": "https://servicemanagement.googleapis.com/", |
706 "schemas": { | 711 "schemas": { |
707 "Api": { | 712 "Api": { |
708 "description": "Api is a light-weight descriptor for a protocol buff
er service.", | 713 "description": "Api is a light-weight descriptor for a protocol buff
er service.", |
709 "id": "Api", | 714 "id": "Api", |
710 "properties": { | 715 "properties": { |
711 "methods": { | 716 "methods": { |
712 "description": "The methods of this api, in unspecified orde
r.", | 717 "description": "The methods of this api, in unspecified orde
r.", |
713 "items": { | 718 "items": { |
714 "$ref": "Method" | 719 "$ref": "Method" |
(...skipping 158 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
873 "type": "string" | 878 "type": "string" |
874 }, | 879 }, |
875 "name": { | 880 "name": { |
876 "description": "The fully qualified name of the API which is
included.", | 881 "description": "The fully qualified name of the API which is
included.", |
877 "type": "string" | 882 "type": "string" |
878 } | 883 } |
879 }, | 884 }, |
880 "type": "object" | 885 "type": "object" |
881 }, | 886 }, |
882 "Service": { | 887 "Service": { |
883 "description": "`Service` is the root object of Google service confi
guration schema. It\ndescribes basic information about a service, such as the na
me 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\nspeci
fic aspect, such as auth. See each proto message definition for details.\n\nExam
ple:\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.ca
lendar.v3.Calendar\n backend:\n rules:\n - selector: \"google.calen
dar.v3.*\"\n address: calendar.example.com", | 888 "description": "`Service` is the root object of Google service confi
guration schema. It\ndescribes basic information about a service, such as the na
me 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\nspeci
fic aspect, such as auth. See each proto message definition for details.\n\nExam
ple:\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.ca
lendar.v3.Calendar\n authentication:\n providers:\n - id: google_ca
lendar_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", |
884 "id": "Service", | 889 "id": "Service", |
885 "properties": { | 890 "properties": { |
886 "id": { | 891 "id": { |
887 "description": "A unique ID for a specific instance of this
message, typically assigned\nby the client for tracking purpose. If empty, the s
erver may choose to\ngenerate one instead.", | 892 "description": "A unique ID for a specific instance of this
message, typically assigned\nby the client for tracking purpose. If empty, the s
erver may choose to\ngenerate one instead.", |
888 "type": "string" | 893 "type": "string" |
889 }, | 894 }, |
890 "enums": { | 895 "enums": { |
891 "description": "A list of all enum types included in this AP
I service. Enums\nreferenced directly or indirectly by the `apis` are automatic
ally\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.Some
Enum", | 896 "description": "A list of all enum types included in this AP
I service. Enums\nreferenced directly or indirectly by the `apis` are automatic
ally\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.Some
Enum", |
892 "items": { | 897 "items": { |
893 "$ref": "Enum" | 898 "$ref": "Enum" |
(...skipping 420 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1314 "description": "Names of the logs to be sent to this destina
tion. Each name must\nbe defined in the Service.logs section. If the log name is
\nnot a domain scoped name, it will be automatically prefixed with\nthe service
name followed by \"/\".", | 1319 "description": "Names of the logs to be sent to this destina
tion. Each name must\nbe defined in the Service.logs section. If the log name is
\nnot a domain scoped name, it will be automatically prefixed with\nthe service
name followed by \"/\".", |
1315 "items": { | 1320 "items": { |
1316 "type": "string" | 1321 "type": "string" |
1317 }, | 1322 }, |
1318 "type": "array" | 1323 "type": "array" |
1319 } | 1324 } |
1320 }, | 1325 }, |
1321 "type": "object" | 1326 "type": "object" |
1322 }, | 1327 }, |
1323 "Authentication": { | 1328 "Authentication": { |
1324 "description": "`Authentication` defines the authentication configur
ation for an API.\n\nExample for an API targeted for external use:\n\n name:
calendar.googleapis.com\n authentication:\n rules:\n - selector: \"
*\"\n oauth:\n canonical_scopes: https://www.googleapis.com/auth
/calendar\n\n - selector: google.calendar.Delegate\n oauth:\n
canonical_scopes: https://www.googleapis.com/auth/calendar.read", | 1329 "description": "`Authentication` defines the authentication configur
ation for an API.\n\nExample for an API targeted for external use:\n\n name:
calendar.googleapis.com\n authentication:\n providers:\n - id: goog
le_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", |
1325 "id": "Authentication", | 1330 "id": "Authentication", |
1326 "properties": { | 1331 "properties": { |
1327 "providers": { | 1332 "providers": { |
1328 "description": "Defines a set of authentication providers th
at a service supports.", | 1333 "description": "Defines a set of authentication providers th
at a service supports.", |
1329 "items": { | 1334 "items": { |
1330 "$ref": "AuthProvider" | 1335 "$ref": "AuthProvider" |
1331 }, | 1336 }, |
1332 "type": "array" | 1337 "type": "array" |
1333 }, | 1338 }, |
1334 "rules": { | 1339 "rules": { |
(...skipping 62 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1397 "description": "A list of API backend rules that apply to in
dividual API methods.\n\n**NOTE:** All service configuration rules follow \"last
one wins\" order.", | 1402 "description": "A list of API backend rules that apply to in
dividual API methods.\n\n**NOTE:** All service configuration rules follow \"last
one wins\" order.", |
1398 "items": { | 1403 "items": { |
1399 "$ref": "BackendRule" | 1404 "$ref": "BackendRule" |
1400 }, | 1405 }, |
1401 "type": "array" | 1406 "type": "array" |
1402 } | 1407 } |
1403 }, | 1408 }, |
1404 "type": "object" | 1409 "type": "object" |
1405 }, | 1410 }, |
1406 "AuditConfig": { | 1411 "AuditConfig": { |
1407 "description": "Enables \"data access\" audit logging for a service
and specifies a list\nof members that are log-exempted.", | 1412 "description": "Provides the configuration for non-admin_activity lo
gging for a service.\nControls exemptions and specific log sub-types.", |
1408 "id": "AuditConfig", | 1413 "id": "AuditConfig", |
1409 "properties": { | 1414 "properties": { |
1410 "service": { | 1415 "service": { |
1411 "description": "Specifies a service that will be enabled for
\"data access\" audit\nlogging.\nFor example, `resourcemanager`, `storage`, `co
mpute`.\n`allServices` is a special value that covers all services.", | 1416 "description": "Specifies a service that will be enabled for
audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServ
ices` is a special value that covers all services.", |
1412 "type": "string" | 1417 "type": "string" |
1413 }, | 1418 }, |
| 1419 "auditLogConfigs": { |
| 1420 "description": "The configuration for each type of logging\n
Next ID: 4", |
| 1421 "items": { |
| 1422 "$ref": "AuditLogConfig" |
| 1423 }, |
| 1424 "type": "array" |
| 1425 }, |
1414 "exemptedMembers": { | 1426 "exemptedMembers": { |
1415 "description": "Specifies the identities that are exempted f
rom \"data access\" audit\nlogging for the `service` specified above.\nFollows t
he same format of Binding.members.", | 1427 "description": "Specifies the identities that are exempted f
rom \"data access\" audit\nlogging for the `service` specified above.\nFollows t
he same format of Binding.members.", |
1416 "items": { | 1428 "items": { |
1417 "type": "string" | 1429 "type": "string" |
1418 }, | 1430 }, |
1419 "type": "array" | 1431 "type": "array" |
1420 } | 1432 } |
1421 }, | 1433 }, |
1422 "type": "object" | 1434 "type": "object" |
1423 }, | 1435 }, |
(...skipping 455 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1879 "type": "array" | 1891 "type": "array" |
1880 }, | 1892 }, |
1881 "message": { | 1893 "message": { |
1882 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", | 1894 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
1883 "type": "string" | 1895 "type": "string" |
1884 } | 1896 } |
1885 }, | 1897 }, |
1886 "type": "object" | 1898 "type": "object" |
1887 }, | 1899 }, |
1888 "Endpoint": { | 1900 "Endpoint": { |
1889 "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 monitorin
g\nconfiguration.\n\nExample service configuration:\n\n name: library-example
.googleapis.com\n endpoints:\n # Below entry makes 'google.example.libra
ry.v1.Library'\n # API be served from endpoint address library-example.goog
leapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backe
nd, for\n # it to decide whether the subsequent cross-origin request is\n
# allowed to proceed.\n - name: library-example.googleapis.com\n api
s: google.example.library.v1.Library\n allow_cors: true\n # Below entr
y makes 'google.example.library.v1.Library'\n # API be served from endpoint
address\n # google.example.library-example.v1.LibraryManager.\n - name:
library-manager.googleapis.com\n apis: google.example.library.v1.LibraryMa
nager\n # BNS address for a borg job. Can specify a task by appending\n
# \"/taskId\" (e.g. \"/0\") to the job spec.\n\nExample OpenAPI extension for
endpoint with allow_cors set to true:\n\n {\n \"swagger\": \"2.0\",\n
\"info\": {\n \"description\": \"A simple...\"\n },\n \"host
\": \"MY_PROJECT_ID.appspot.com\",\n \"x-google-endpoints\": [{\n \"
name\": \"MY_PROJECT_ID.appspot.com\",\n \"allow_cors\": \"true\"\n
}]\n }", | 1901 "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 monitorin
g\nconfiguration.\n\nExample service configuration:\n\n name: library-example
.googleapis.com\n endpoints:\n # Below entry makes 'google.example.libra
ry.v1.Library'\n # API be served from endpoint address library-example.goog
leapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backe
nd, for\n # it to decide whether the subsequent cross-origin request is\n
# allowed to proceed.\n - name: library-example.googleapis.com\n all
ow_cors: true", |
1890 "id": "Endpoint", | 1902 "id": "Endpoint", |
1891 "properties": { | 1903 "properties": { |
1892 "apis": { | 1904 "apis": { |
1893 "description": "The list of APIs served by this endpoint.", | 1905 "description": "The list of APIs served by this endpoint.", |
1894 "items": { | 1906 "items": { |
1895 "type": "string" | 1907 "type": "string" |
1896 }, | 1908 }, |
1897 "type": "array" | 1909 "type": "array" |
1898 }, | 1910 }, |
1899 "allowCors": { | 1911 "allowCors": { |
(...skipping 60 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1960 }, | 1972 }, |
1961 "Option": { | 1973 "Option": { |
1962 "description": "A protocol buffer option, which can be attached to a
message, field,\nenumeration, etc.", | 1974 "description": "A protocol buffer option, which can be attached to a
message, field,\nenumeration, etc.", |
1963 "id": "Option", | 1975 "id": "Option", |
1964 "properties": { | 1976 "properties": { |
1965 "value": { | 1977 "value": { |
1966 "additionalProperties": { | 1978 "additionalProperties": { |
1967 "description": "Properties of the object. Contains field
@type with type URL.", | 1979 "description": "Properties of the object. Contains field
@type with type URL.", |
1968 "type": "any" | 1980 "type": "any" |
1969 }, | 1981 }, |
1970 "description": "The option's value. For example, `\"com.goog
le.protobuf\"`.", | 1982 "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 s
tored as an int32\nvalue using the google.protobuf.Int32Value type.", |
1971 "type": "object" | 1983 "type": "object" |
1972 }, | 1984 }, |
1973 "name": { | 1985 "name": { |
1974 "description": "The option's name. For example, `\"java_pack
age\"`.", | 1986 "description": "The option's name. For protobuf built-in opt
ions (options defined in\ndescriptor.proto), this is the short name. For example
, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. F
or example,\n`\"google.api.http\"`.", |
1975 "type": "string" | 1987 "type": "string" |
1976 } | 1988 } |
1977 }, | 1989 }, |
1978 "type": "object" | 1990 "type": "object" |
1979 }, | 1991 }, |
1980 "HttpRule": { | 1992 "HttpRule": { |
1981 "description": "`HttpRule` defines the mapping of an RPC method to o
ne or more HTTP\nREST APIs. The mapping determines what portions of the request
\nmessage are populated from the path, query parameters, or body of\nthe HTTP re
quest. The mapping is typically specified as an\n`google.api.http` annotation,
see \"google/api/annotations.proto\"\nfor details.\n\nThe mapping consists of a
field specifying the path template and\nmethod kind. The path template can refe
r to fields in the request\nmessage, as in the example below which describes a R
EST GET\noperation on a resource collection of messages:\n\n```proto\nservice Me
ssaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (
google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n}\nme
ssage GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }
\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `su
b.subfield` is url-mapped\n}\nmessage Message {\n string text = 1; // content o
f the resource\n}\n```\n\nThis definition enables an automatic, bidrectional map
ping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/message
s/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"
foo\"))`\n\nIn general, not only fields but also field paths can be referenced\n
from a path pattern. Fields mapped to the path pattern cannot be\nrepeated and m
ust have a primitive (non-message) type.\n\nAny fields in the request message wh
ich are not bound by the path\npattern automatically become (optional) HTTP quer
y\nparameters. Assume the following definition of the request message:\n\n```pro
to\nmessage 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 par
ameter\n}\n```\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RP
C\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMess
age(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nN
ote 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 r
epeated 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\nspe
cifies the mapping. Consider a REST update method on the\nmessage resource colle
ction:\n\n```proto\nservice Messaging {\n rpc UpdateMessage(UpdateMessageReques
t) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messa
ges/{message_id}\"\n body: \"message\"\n };\n }\n}\nmessage UpdateMessa
geRequest {\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 tha
t\nevery field not bound by the path template should be mapped to the\nrequest b
ody. This enables the following alternative definition of\nthe update method:\n
\n```proto\nservice Messaging {\n rpc UpdateMessage(Message) returns (Message)
{\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n
body: \"*\"\n };\n }\n}\nmessage 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!\" }` | `U
pdateMessage(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 def
ine multiple HTTP methods for one RPC by using\nthe `additional_bindings` option
. Example:\n\n```proto\nservice Messaging {\n rpc GetMessage(GetMessageRequest)
returns (Message) {\n option (google.api.http) = {\n get: \"/v1/message
s/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id
}/messages/{message_id}\"\n }\n };\n }\n}\nmessage GetMessageRequest {\
n string message_id = 1;\n string user_id = 2;\n}\n```\n\nThis enables the fol
lowing 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 spec
ifies either `*` or a field path, or is\n omitted. If omitted, it assumes ther
e is no HTTP body.\n2. Leaf fields (recursive expansion of nested messages in th
e\n request) can be classified into three types:\n (a) Matched in the URL t
emplate.\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. U
RL 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 S
egments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL |
Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n Fiel
dPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*
` matches a single path segment. It follows the semantics of\n[RFC 6570](https:/
/tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syn
tax `**` matches zero or more path segments. It follows the semantics\nof [RFC 6
570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved\nExpansion. NOT
E: it must be the last segment in the path except the Verb.\n\nThe syntax `LITER
AL` matches literal text in the URL path.\n\nThe syntax `Variable` matches the e
ntire path as specified by its template;\nthis nested template must not contain
further variables. If a variable\nmatches a single path segment, its template ma
y be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nNOTE: the field paths
in variables and in the `body` must not refer to\nrepeated fields or map fields
.\n\nUse CustomHttpPattern to specify any HTTP method that is not included in th
e\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified
for\na given URL path rule. The wild-card rule is useful for services that provi
de\ncontent to Web (HTML) clients.", | 1993 "description": "`HttpRule` defines the mapping of an RPC method to o
ne or more HTTP\nREST APIs. The mapping determines what portions of the request
\nmessage are populated from the path, query parameters, or body of\nthe HTTP re
quest. The mapping is typically specified as an\n`google.api.http` annotation,
see \"google/api/annotations.proto\"\nfor details.\n\nThe mapping consists of a
field specifying the path template and\nmethod kind. The path template can refe
r to fields in the request\nmessage, as in the example below which describes a R
EST GET\noperation on a resource collection of messages:\n\n\n service Messag
ing {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n opti
on (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n
}\n }\n message GetMessageRequest {\n message SubMessage {\n s
tring subfield = 1;\n }\n string message_id = 1; // mapped to the URL\
n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n messag
e Message {\n string text = 1; // content of the resource\n }\n\nThe sam
e http annotation can alternatively be expressed inside the\n`GRPC API Configura
tion` YAML file.\n\n http:\n rules:\n - selector: <proto_package_
name>.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfie
ld}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON
to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `G
etMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn gene
ral, 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 primitiv
e (non-message) type.\n\nAny fields in the request message which are not bound b
y the path\npattern automatically become (optional) HTTP query\nparameters. Assu
me the following definition of the request message:\n\n\n message GetMessageR
equest {\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 pa
rameter\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` | `GetMe
ssage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\
nNote that fields which are mapped to HTTP parameters must have a\nprimitive typ
e 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&pa
ram=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\ns
pecifies the mapping. Consider a REST update method on the\nmessage resource col
lection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequ
est) 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; // mappe
d 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(m
essage_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 temp
late should be mapped to the\nrequest body. This enables the following alternat
ive definition of\nthe update method:\n\n service Messaging {\n rpc Upda
teMessage(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\nHTT
P | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateM
essage(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 bo
und by the path end in\nthe body. This makes this option more rarely used in pra
ctice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhic
h don't use the URL at all for transferring data.\n\nIt is possible to define mu
ltiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Exam
ple:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns
(Message) {\n option (google.api.http) = {\n get: \"/v1/message
s/{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\nma
ppings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(mess
age_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 map
ping 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 assumes there is no HTTP body.\n2. Leaf fields (recursi
ve 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 fi
eld)\n (c) All other fields.\n3. URL query parameters found in the HTTP reque
st 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 Templa
te = \"/\" 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. It follows
the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2
Simple String\nExpansion.\n\nThe syntax `**` matches zero or more path segments
. It follows the semantics\nof [RFC 6570](https://tools.ietf.org/html/rfc6570) S
ection 3.2.3 Reserved\nExpansion. NOTE: it must be the last segment in the path
except the Verb.\n\nThe syntax `LITERAL` matches literal text in the URL path.\n
\nThe syntax `Variable` matches the entire path as specified by its template;\nt
his nested template must not contain further variables. If a variable\nmatches a
single path segment, its template may be omitted, e.g. `{var}`\nis equivalent t
o `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not re
fer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any H
TTP method that is not included in the\n`pattern` field, such as HEAD, or \"*\"
to leave the HTTP method unspecified for\na given URL path rule. The wild-card r
ule is useful for services that provide\ncontent to Web (HTML) clients.", |
1982 "id": "HttpRule", | 1994 "id": "HttpRule", |
1983 "properties": { | 1995 "properties": { |
1984 "custom": { | 1996 "custom": { |
1985 "$ref": "CustomHttpPattern", | 1997 "$ref": "CustomHttpPattern", |
1986 "description": "Custom pattern is used for defining custom v
erbs." | 1998 "description": "Custom pattern is used for defining custom v
erbs." |
1987 }, | 1999 }, |
1988 "responseBody": { | 2000 "responseBody": { |
1989 "description": "The name of the response field whose value i
s mapped to the HTTP body of\nresponse. Other response fields are ignored. This
field is optional. When\nnot set, the response message will be used as HTTP body
of response.\nNOTE: the referred field must be not a repeated field and must be
present\nat the top-level of response message type.", | 2001 "description": "The name of the response field whose value i
s mapped to the HTTP body of\nresponse. Other response fields are ignored. This
field is optional. When\nnot set, the response message will be used as HTTP body
of response.\nNOTE: the referred field must be not a repeated field and must be
present\nat the top-level of response message type.", |
1990 "type": "string" | 2002 "type": "string" |
1991 }, | 2003 }, |
1992 "additionalBindings": { | 2004 "additionalBindings": { |
1993 "description": "Additional HTTP bindings for the selector. N
ested bindings must\nnot contain an `additional_bindings` field themselves (that
is,\nthe nesting may only be one level deep).", | 2005 "description": "Additional HTTP bindings for the selector. N
ested bindings must\nnot contain an `additional_bindings` field themselves (that
is,\nthe nesting may only be one level deep).", |
1994 "items": { | 2006 "items": { |
1995 "$ref": "HttpRule" | 2007 "$ref": "HttpRule" |
1996 }, | 2008 }, |
1997 "type": "array" | 2009 "type": "array" |
1998 }, | 2010 }, |
1999 "mediaDownload": { | 2011 "mediaDownload": { |
2000 "$ref": "MediaDownload", | 2012 "$ref": "MediaDownload", |
2001 "description": "Do not use this. For media support, add inst
ead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration." | 2013 "description": "Do not use this. For media support, add inst
ead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration." |
2002 }, | 2014 }, |
2003 "body": { | 2015 "body": { |
2004 "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 pat
h pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated fie
ld and must be\npresent at the top-level of response message type.", | 2016 "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 pat
h pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated fie
ld and must be\npresent at the top-level of request message type.", |
2005 "type": "string" | 2017 "type": "string" |
2006 }, | 2018 }, |
2007 "put": { | 2019 "put": { |
2008 "description": "Used for updating a resource.", | 2020 "description": "Used for updating a resource.", |
2009 "type": "string" | 2021 "type": "string" |
2010 }, | 2022 }, |
2011 "get": { | 2023 "get": { |
2012 "description": "Used for listing and getting information abo
ut resources.", | 2024 "description": "Used for listing and getting information abo
ut resources.", |
2013 "type": "string" | 2025 "type": "string" |
2014 }, | 2026 }, |
(...skipping 144 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2159 }, | 2171 }, |
2160 "SystemParameter": { | 2172 "SystemParameter": { |
2161 "description": "Define a parameter's name and location. The paramete
r may be passed as either\nan HTTP header or a URL query parameter, and if both
are passed the behavior\nis implementation-dependent.", | 2173 "description": "Define a parameter's name and location. The paramete
r may be passed as either\nan HTTP header or a URL query parameter, and if both
are passed the behavior\nis implementation-dependent.", |
2162 "id": "SystemParameter", | 2174 "id": "SystemParameter", |
2163 "properties": { | 2175 "properties": { |
2164 "urlQueryParameter": { | 2176 "urlQueryParameter": { |
2165 "description": "Define the URL query parameter name to use f
or the parameter. It is case\nsensitive.", | 2177 "description": "Define the URL query parameter name to use f
or the parameter. It is case\nsensitive.", |
2166 "type": "string" | 2178 "type": "string" |
2167 }, | 2179 }, |
2168 "name": { | 2180 "name": { |
2169 "description": "Define the name of the parameter, such as \"
api_key\", \"alt\", \"callback\",\nand etc. It is case sensitive.", | 2181 "description": "Define the name of the parameter, such as \"
api_key\" . It is case sensitive.", |
2170 "type": "string" | 2182 "type": "string" |
2171 }, | 2183 }, |
2172 "httpHeader": { | 2184 "httpHeader": { |
2173 "description": "Define the HTTP header name to use for the p
arameter. It is case\ninsensitive.", | 2185 "description": "Define the HTTP header name to use for the p
arameter. It is case\ninsensitive.", |
2174 "type": "string" | 2186 "type": "string" |
2175 } | 2187 } |
2176 }, | 2188 }, |
2177 "type": "object" | 2189 "type": "object" |
2178 }, | 2190 }, |
2179 "Enum": { | 2191 "Enum": { |
(...skipping 345 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2525 "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 no
t 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 restrictio
n will break clients that\nrely on this method and only had access to it through
GOOGLE_INTERNAL.", | 2537 "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 no
t 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 restrictio
n will break clients that\nrely on this method and only had access to it through
GOOGLE_INTERNAL.", |
2526 "type": "string" | 2538 "type": "string" |
2527 }, | 2539 }, |
2528 "selector": { | 2540 "selector": { |
2529 "description": "Selects methods, messages, fields, enums, et
c. to which this rule applies.\n\nRefer to selector for syntax details.", | 2541 "description": "Selects methods, messages, fields, enums, et
c. to which this rule applies.\n\nRefer to selector for syntax details.", |
2530 "type": "string" | 2542 "type": "string" |
2531 } | 2543 } |
2532 }, | 2544 }, |
2533 "type": "object" | 2545 "type": "object" |
2534 }, | 2546 }, |
| 2547 "AuditLogConfig": { |
| 2548 "description": "Provides the configuration for a sub-type of logging
.", |
| 2549 "id": "AuditLogConfig", |
| 2550 "properties": { |
| 2551 "logType": { |
| 2552 "description": "The log type that this config enables.", |
| 2553 "enum": [ |
| 2554 "LOG_TYPE_UNSPECIFIED", |
| 2555 "ADMIN_READ", |
| 2556 "DATA_WRITE", |
| 2557 "DATA_READ" |
| 2558 ], |
| 2559 "enumDescriptions": [ |
| 2560 "Default case. Should never be this.", |
| 2561 "Log admin reads", |
| 2562 "Log data writes", |
| 2563 "Log data reads" |
| 2564 ], |
| 2565 "type": "string" |
| 2566 }, |
| 2567 "exemptedMembers": { |
| 2568 "description": "Specifies the identities that are exempted f
rom this type of logging\nFollows the same format of Binding.members.", |
| 2569 "items": { |
| 2570 "type": "string" |
| 2571 }, |
| 2572 "type": "array" |
| 2573 } |
| 2574 }, |
| 2575 "type": "object" |
| 2576 }, |
2535 "UndeleteServiceResponse": { | 2577 "UndeleteServiceResponse": { |
2536 "description": "Response message for UndeleteService method.", | 2578 "description": "Response message for UndeleteService method.", |
2537 "id": "UndeleteServiceResponse", | 2579 "id": "UndeleteServiceResponse", |
2538 "properties": { | 2580 "properties": { |
2539 "service": { | 2581 "service": { |
2540 "$ref": "ManagedService", | 2582 "$ref": "ManagedService", |
2541 "description": "Revived service resource." | 2583 "description": "Revived service resource." |
2542 } | 2584 } |
2543 }, | 2585 }, |
2544 "type": "object" | 2586 "type": "object" |
(...skipping 160 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2705 "type": "array" | 2747 "type": "array" |
2706 } | 2748 } |
2707 }, | 2749 }, |
2708 "type": "object" | 2750 "type": "object" |
2709 }, | 2751 }, |
2710 "SystemParameters": { | 2752 "SystemParameters": { |
2711 "description": "### System parameter configuration\n\nA system param
eter is a special kind of parameter defined by the API\nsystem, not by an indivi
dual API. It is typically mapped to an HTTP header\nand/or a URL query parameter
. This configuration specifies which methods\nchange the names of the system par
ameters.", | 2753 "description": "### System parameter configuration\n\nA system param
eter is a special kind of parameter defined by the API\nsystem, not by an indivi
dual API. It is typically mapped to an HTTP header\nand/or a URL query parameter
. This configuration specifies which methods\nchange the names of the system par
ameters.", |
2712 "id": "SystemParameters", | 2754 "id": "SystemParameters", |
2713 "properties": { | 2755 "properties": { |
2714 "rules": { | 2756 "rules": { |
2715 "description": "Define system parameters.\n\nThe parameters
defined here will override the default parameters\nimplemented by the system. If
this field is missing from the service\nconfig, default system parameters will
be used. Default system parameters\nand names is implementation-dependent.\n\nEx
ample: define api key and alt name for all methods\n\nsystem_parameters\n rules
:\n - selector: \"*\"\n parameters:\n - name: api_key\n
url_query_parameter: api_key\n - name: alt\n http_header: Respon
se-Content-Type\n\nExample: define 2 api key names for a specific method.\n\nsys
tem_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n
- name: api_key\n http_header: Api-Key1\n - name: api_key
\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules f
ollow \"last one wins\" order.", | 2757 "description": "Define system parameters.\n\nThe parameters
defined here will override the default parameters\nimplemented by the system. If
this field is missing from the service\nconfig, default system parameters will
be used. Default system parameters\nand names is implementation-dependent.\n\nEx
ample: define api key for all methods\n\n system_parameters\n rules:\n
- selector: \"*\"\n parameters:\n - name: api_key\n
url_query_parameter: api_key\n\n\nExample: define 2 api key names for
a specific method.\n\n system_parameters\n rules:\n - selector:
\"/ListShelves\"\n parameters:\n - name: api_key\n
http_header: Api-Key1\n - name: api_key\n http_heade
r: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\
" order.", |
2716 "items": { | 2758 "items": { |
2717 "$ref": "SystemParameterRule" | 2759 "$ref": "SystemParameterRule" |
2718 }, | 2760 }, |
2719 "type": "array" | 2761 "type": "array" |
2720 } | 2762 } |
2721 }, | 2763 }, |
2722 "type": "object" | 2764 "type": "object" |
2723 }, | 2765 }, |
2724 "LabelDescriptor": { | 2766 "LabelDescriptor": { |
2725 "description": "A description of a label.", | 2767 "description": "A description of a label.", |
(...skipping 21 matching lines...) Expand all Loading... |
2747 "description": "The label key.", | 2789 "description": "The label key.", |
2748 "type": "string" | 2790 "type": "string" |
2749 } | 2791 } |
2750 }, | 2792 }, |
2751 "type": "object" | 2793 "type": "object" |
2752 }, | 2794 }, |
2753 "Usage": { | 2795 "Usage": { |
2754 "description": "Configuration controlling usage of a service.", | 2796 "description": "Configuration controlling usage of a service.", |
2755 "id": "Usage", | 2797 "id": "Usage", |
2756 "properties": { | 2798 "properties": { |
| 2799 "producerNotificationChannel": { |
| 2800 "description": "The full resource name of a channel used for
sending notifications to the\nservice producer.\n\nGoogle Service Management cu
rrently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) a
s 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 fo
rmat\ndocumented in https://cloud.google.com/pubsub/docs/overview.", |
| 2801 "type": "string" |
| 2802 }, |
2757 "requirements": { | 2803 "requirements": { |
2758 "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-enabl
ed'.", | 2804 "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-enabl
ed'.", |
2759 "items": { | 2805 "items": { |
2760 "type": "string" | 2806 "type": "string" |
2761 }, | 2807 }, |
2762 "type": "array" | 2808 "type": "array" |
2763 }, | 2809 }, |
2764 "rules": { | 2810 "rules": { |
2765 "description": "A list of usage rules that apply to individu
al API methods.\n\n**NOTE:** All service configuration rules follow \"last one w
ins\" order.", | 2811 "description": "A list of usage rules that apply to individu
al API methods.\n\n**NOTE:** All service configuration rules follow \"last one w
ins\" order.", |
2766 "items": { | 2812 "items": { |
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2823 "type": "string" | 2869 "type": "string" |
2824 } | 2870 } |
2825 }, | 2871 }, |
2826 "type": "object" | 2872 "type": "object" |
2827 } | 2873 } |
2828 }, | 2874 }, |
2829 "servicePath": "", | 2875 "servicePath": "", |
2830 "title": "Google Service Management API", | 2876 "title": "Google Service Management API", |
2831 "version": "v1" | 2877 "version": "v1" |
2832 } | 2878 } |
OLD | NEW |