| Index: discovery/googleapis/serviceuser__v1.json
|
| diff --git a/discovery/googleapis/serviceuser__v1.json b/discovery/googleapis/serviceuser__v1.json
|
| index a1423c79d3698efb814bfd5e12868492572f5d4b..5dec7f4a7ab400b6ab2645672bcdd9f6ad9370ef 100644
|
| --- a/discovery/googleapis/serviceuser__v1.json
|
| +++ b/discovery/googleapis/serviceuser__v1.json
|
| @@ -31,27 +31,6 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| - "upload_protocol": {
|
| - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "prettyPrint": {
|
| - "default": "true",
|
| - "description": "Returns response with indentations and line breaks.",
|
| - "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"
|
| - },
|
| "callback": {
|
| "description": "JSONP",
|
| "location": "query",
|
| @@ -107,13 +86,34 @@
|
| "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"
|
| },
|
| - "oauth_token": {
|
| - "description": "OAuth 2.0 token for the current user.",
|
| + "upload_protocol": {
|
| + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "prettyPrint": {
|
| + "default": "true",
|
| + "description": "Returns response with indentations and line breaks.",
|
| + "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"
|
| }
|
| @@ -160,13 +160,6 @@
|
| "parent"
|
| ],
|
| "parameters": {
|
| - "parent": {
|
| - "description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| "pageToken": {
|
| "description": "Token identifying which result to start with; returned by a previous list\ncall.",
|
| "location": "query",
|
| @@ -177,6 +170,13 @@
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| + },
|
| + "parent": {
|
| + "description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v1/{+parent}/services",
|
| @@ -252,128 +252,143 @@
|
| }
|
| }
|
| },
|
| - "revision": "20170317",
|
| + "revision": "20170410",
|
| "rootUrl": "https://serviceuser.googleapis.com/",
|
| "schemas": {
|
| - "UsageRule": {
|
| - "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
|
| - "id": "UsageRule",
|
| + "LoggingDestination": {
|
| + "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
|
| + "id": "LoggingDestination",
|
| "properties": {
|
| - "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"
|
| + "logs": {
|
| + "description": "Names of the logs to be sent to this destination. 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 \"/\".",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| },
|
| - "allowUnregisteredCalls": {
|
| - "description": "True, if the method allows unregistered calls; false otherwise.",
|
| - "type": "boolean"
|
| + "monitoredResource": {
|
| + "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
|
| + "type": "string"
|
| }
|
| },
|
| "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",
|
| + "Option": {
|
| + "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
|
| + "id": "Option",
|
| "properties": {
|
| - "providerId": {
|
| - "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
|
| + "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"
|
| },
|
| - "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"
|
| + "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"
|
| }
|
| },
|
| "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",
|
| + "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": {
|
| - "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.",
|
| + "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": "DocumentationRule"
|
| + "$ref": "LoggingDestination"
|
| },
|
| "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.",
|
| + "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": "Page"
|
| + "$ref": "LoggingDestination"
|
| },
|
| "type": "array"
|
| - },
|
| - "summary": {
|
| - "description": "A short summary of what the service does. Can only be provided by\nplain text.",
|
| - "type": "string"
|
| - },
|
| - "documentationRootUrl": {
|
| - "description": "The URL to the root of documentation.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AuthenticationRule": {
|
| - "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",
|
| + "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": {
|
| - "selector": {
|
| - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "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"
|
| },
|
| - "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"
|
| + "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"
|
| },
|
| - "oauth": {
|
| - "$ref": "OAuthRequirements",
|
| - "description": "The requirements for OAuth credentials."
|
| + "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"
|
| },
|
| - "requirements": {
|
| - "description": "Requirements for additional authentication providers.",
|
| - "items": {
|
| - "$ref": "AuthRequirement"
|
| + "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"
|
| + },
|
| + "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"
|
| + },
|
| + "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": {
|
| + "additionalProperties": {
|
| + "format": "int64",
|
| + "type": "string"
|
| },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "BackendRule": {
|
| - "description": "A backend rule provides configuration for an individual API element.",
|
| - "id": "BackendRule",
|
| - "properties": {
|
| - "address": {
|
| - "description": "The address of the API backend.",
|
| + "description": "Tiered limit values. Also allows for regional or zone overrides for these\nvalues if \"/{region}\" or \"/{zone}\" is specified in the unit field.\n\nCurrently supported tiers from low to high:\nVERY_LOW, LOW, STANDARD, HIGH, VERY_HIGH\n\nTo apply different limit values for users according to their tiers, specify\nthe values for the tiers you want to differentiate. For example:\n{LOW:100, STANDARD:500, HIGH:1000, VERY_HIGH:5000}\n\nThe limit value for each tier is optional except for the tier STANDARD.\nThe limit value for an unspecified tier falls to the value of its next\ntier towards tier STANDARD. For the above example, the limit value for tier\nSTANDARD is 500.\n\nTo apply the same limit value for all users, just specify limit value for\ntier STANDARD. For example: {STANDARD:500}.\n\nTo apply a regional overide for a tier, add a map entry with key\n\"<TIER>/<region>\", where <region> is a region name. Similarly, for a zone\noverride, add a map entry with key \"<TIER>/{zone}\".\nFurther, a wildcard can be used at the end of a zone name in order to\nspecify zone level overrides. For example:\nLOW: 10, STANDARD: 50, HIGH: 100,\nLOW/us-central1: 20, STANDARD/us-central1: 60, HIGH/us-central1: 200,\nLOW/us-central1-*: 10, STANDARD/us-central1-*: 20, HIGH/us-central1-*: 80\n\nThe regional overrides tier set for each region must be the same as\nthe tier set for default limit values. Same rule applies for zone overrides\ntier as well.\n\nUsed by metric-based quotas only.",
|
| + "type": "object"
|
| + },
|
| + "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 * \"/{organization}\" quota for an organization.\n * \"/{project}\" quota for a project.\n * \"/{folder}\" quota for a folder.\n * \"/{resource}\" quota for a universal resource.\n* Zero or more quota segmentation dimension. Not all combos are valid.\n * \"/{region}\" quota for every region. Not to be used with time intervals.\n * Otherwise the resources granted on the target is not segmented.\n * \"/{zone}\" quota for every zone. Not to be used with time intervals.\n * Otherwise the resources granted on the target is not segmented.\n * \"/{resource}\" quota for a resource associated with a project or org.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n* \"1/min/{user}\" for quota per minute per user.\n* \"1/min/{organization}\" for quota per minute per organization.\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"
|
| },
|
| - "selector": {
|
| - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "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"
|
| },
|
| - "deadline": {
|
| - "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
|
| - "format": "double",
|
| - "type": "number"
|
| + "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 group-based quota limits, the name must be unique within the quota\ngroup. If a name is not provided, it will be generated from the limit_by\nand duration fields.\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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Api": {
|
| - "description": "Api is a light-weight descriptor for a protocol buffer service.",
|
| - "id": "Api",
|
| + "Method": {
|
| + "description": "Method represents a method of an api.",
|
| + "id": "Method",
|
| "properties": {
|
| + "responseStreaming": {
|
| + "description": "If true, the response is streamed.",
|
| + "type": "boolean"
|
| + },
|
| "name": {
|
| - "description": "The fully qualified name of this api, including package name\nfollowed by the api's simple name.",
|
| + "description": "The simple name of this method.",
|
| "type": "string"
|
| },
|
| + "requestTypeUrl": {
|
| + "description": "A URL of the input message type.",
|
| + "type": "string"
|
| + },
|
| + "requestStreaming": {
|
| + "description": "If true, the request is streamed.",
|
| + "type": "boolean"
|
| + },
|
| "syntax": {
|
| - "description": "The source syntax of the service.",
|
| + "description": "The source syntax of this method.",
|
| "enum": [
|
| "SYNTAX_PROTO2",
|
| "SYNTAX_PROTO3"
|
| @@ -384,994 +399,913 @@
|
| ],
|
| "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",
|
| + "responseTypeUrl": {
|
| + "description": "The URL of the output message type.",
|
| "type": "string"
|
| },
|
| - "mixins": {
|
| - "description": "Included APIs. See Mixin.",
|
| - "items": {
|
| - "$ref": "Mixin"
|
| - },
|
| - "type": "array"
|
| - },
|
| "options": {
|
| - "description": "Any metadata attached to the API.",
|
| + "description": "Any metadata attached to the method.",
|
| "items": {
|
| "$ref": "Option"
|
| },
|
| "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",
|
| + "properties": {
|
| + "name": {
|
| + "description": "The fully qualified name of the API which is included.",
|
| + "type": "string"
|
| },
|
| - "methods": {
|
| - "description": "The methods of this api, in unspecified order.",
|
| - "items": {
|
| - "$ref": "Method"
|
| - },
|
| - "type": "array"
|
| + "root": {
|
| + "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
|
| + "type": "string"
|
| }
|
| },
|
| "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",
|
| + "CustomError": {
|
| + "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
|
| + "id": "CustomError",
|
| "properties": {
|
| "rules": {
|
| - "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| + "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "$ref": "AuthenticationRule"
|
| + "$ref": "CustomErrorRule"
|
| },
|
| "type": "array"
|
| },
|
| - "providers": {
|
| - "description": "Defines a set of authentication providers that a service supports.",
|
| + "types": {
|
| + "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
|
| "items": {
|
| - "$ref": "AuthProvider"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Operation": {
|
| - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
|
| - "id": "Operation",
|
| + "Http": {
|
| + "description": "Defines the HTTP configuration for a 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": {
|
| - "done": {
|
| - "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
|
| + "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"
|
| },
|
| - "response": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| + "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"
|
| },
|
| - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
|
| - "type": "object"
|
| - },
|
| - "name": {
|
| - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
|
| - "type": "string"
|
| - },
|
| - "error": {
|
| - "$ref": "Status",
|
| - "description": "The error result of the operation in case of failure or cancellation."
|
| - },
|
| - "metadata": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "SourceInfo": {
|
| + "description": "Source information used to create a Service Config",
|
| + "id": "SourceInfo",
|
| + "properties": {
|
| + "sourceFiles": {
|
| + "description": "All files used during config generation.",
|
| + "items": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "type": "object"
|
| },
|
| - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
|
| - "type": "object"
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Page": {
|
| - "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
|
| - "id": "Page",
|
| + "Control": {
|
| + "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
|
| + "id": "Control",
|
| + "properties": {
|
| + "environment": {
|
| + "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "SystemParameter": {
|
| + "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
|
| + "id": "SystemParameter",
|
| "properties": {
|
| "name": {
|
| - "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n<pre><code>pages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n</code></pre>\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
|
| + "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
|
| "type": "string"
|
| },
|
| - "content": {
|
| - "description": "The Markdown content of the page. You can use <code>(== include {path} ==)</code>\nto include content from a Markdown file.",
|
| + "urlQueryParameter": {
|
| + "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
|
| "type": "string"
|
| },
|
| - "subpages": {
|
| - "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
|
| - "items": {
|
| - "$ref": "Page"
|
| - },
|
| - "type": "array"
|
| + "httpHeader": {
|
| + "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Status": {
|
| - "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which 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 purpose.\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",
|
| + "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": {
|
| - "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"
|
| + "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"
|
| },
|
| - "details": {
|
| - "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
|
| + "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": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "type": "object"
|
| + "$ref": "MonitoringDestination"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AuthProvider": {
|
| - "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",
|
| + "Field": {
|
| + "description": "A single field of a message type.",
|
| + "id": "Field",
|
| "properties": {
|
| - "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",
|
| + "cardinality": {
|
| + "description": "The field cardinality.",
|
| + "enum": [
|
| + "CARDINALITY_UNKNOWN",
|
| + "CARDINALITY_OPTIONAL",
|
| + "CARDINALITY_REQUIRED",
|
| + "CARDINALITY_REPEATED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "For fields with unknown cardinality.",
|
| + "For optional fields.",
|
| + "For required fields. Proto2 syntax only.",
|
| + "For repeated fields."
|
| + ],
|
| "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",
|
| + "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"
|
| },
|
| - "id": {
|
| - "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".",
|
| + "name": {
|
| + "description": "The field name.",
|
| "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",
|
| + "typeUrl": {
|
| + "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "EnumValue": {
|
| - "description": "Enum value definition.",
|
| - "id": "EnumValue",
|
| - "properties": {
|
| + },
|
| "number": {
|
| - "description": "Enum value number.",
|
| + "description": "The field number.",
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "name": {
|
| - "description": "Enum value name.",
|
| + "jsonName": {
|
| + "description": "The field JSON name.",
|
| + "type": "string"
|
| + },
|
| + "kind": {
|
| + "description": "The field type.",
|
| + "enum": [
|
| + "TYPE_UNKNOWN",
|
| + "TYPE_DOUBLE",
|
| + "TYPE_FLOAT",
|
| + "TYPE_INT64",
|
| + "TYPE_UINT64",
|
| + "TYPE_INT32",
|
| + "TYPE_FIXED64",
|
| + "TYPE_FIXED32",
|
| + "TYPE_BOOL",
|
| + "TYPE_STRING",
|
| + "TYPE_GROUP",
|
| + "TYPE_MESSAGE",
|
| + "TYPE_BYTES",
|
| + "TYPE_UINT32",
|
| + "TYPE_ENUM",
|
| + "TYPE_SFIXED32",
|
| + "TYPE_SFIXED64",
|
| + "TYPE_SINT32",
|
| + "TYPE_SINT64"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Field type unknown.",
|
| + "Field type double.",
|
| + "Field type float.",
|
| + "Field type int64.",
|
| + "Field type uint64.",
|
| + "Field type int32.",
|
| + "Field type fixed64.",
|
| + "Field type fixed32.",
|
| + "Field type bool.",
|
| + "Field type string.",
|
| + "Field type group. Proto2 syntax only, and deprecated.",
|
| + "Field type message.",
|
| + "Field type bytes.",
|
| + "Field type uint32.",
|
| + "Field type enum.",
|
| + "Field type sfixed32.",
|
| + "Field type sfixed64.",
|
| + "Field type sint32.",
|
| + "Field type sint64."
|
| + ],
|
| "type": "string"
|
| },
|
| "options": {
|
| - "description": "Protocol buffer options.",
|
| + "description": "The protocol buffer options.",
|
| "items": {
|
| "$ref": "Option"
|
| },
|
| "type": "array"
|
| + },
|
| + "oneofIndex": {
|
| + "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Service": {
|
| - "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",
|
| + "Enum": {
|
| + "description": "Enum type definition.",
|
| + "id": "Enum",
|
| "properties": {
|
| - "visibility": {
|
| - "$ref": "Visibility",
|
| - "description": "API visibility configuration."
|
| - },
|
| "name": {
|
| - "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
|
| - "type": "string"
|
| - },
|
| - "customError": {
|
| - "$ref": "CustomError",
|
| - "description": "Custom error configuration."
|
| - },
|
| - "title": {
|
| - "description": "The product title associated with this service.",
|
| + "description": "Enum type name.",
|
| "type": "string"
|
| },
|
| - "endpoints": {
|
| - "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
|
| + "enumvalue": {
|
| + "description": "Enum value definitions.",
|
| "items": {
|
| - "$ref": "Endpoint"
|
| + "$ref": "EnumValue"
|
| },
|
| "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.",
|
| + "options": {
|
| + "description": "Protocol buffer options.",
|
| "items": {
|
| - "$ref": "Api"
|
| + "$ref": "Option"
|
| },
|
| "type": "array"
|
| },
|
| - "logs": {
|
| - "description": "Defines the logs used by this service.",
|
| - "items": {
|
| - "$ref": "LogDescriptor"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "types": {
|
| - "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
|
| - "items": {
|
| - "$ref": "Type"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "sourceInfo": {
|
| - "$ref": "SourceInfo",
|
| - "description": "Output only. The source information for this configuration if available."
|
| - },
|
| - "http": {
|
| - "$ref": "Http",
|
| - "description": "HTTP configuration."
|
| - },
|
| - "backend": {
|
| - "$ref": "Backend",
|
| - "description": "API backend configuration."
|
| - },
|
| - "systemParameters": {
|
| - "$ref": "SystemParameters",
|
| - "description": "System parameter configuration."
|
| + "sourceContext": {
|
| + "$ref": "SourceContext",
|
| + "description": "The source context."
|
| },
|
| - "documentation": {
|
| - "$ref": "Documentation",
|
| - "description": "Additional API documentation."
|
| + "syntax": {
|
| + "description": "The source syntax.",
|
| + "enum": [
|
| + "SYNTAX_PROTO2",
|
| + "SYNTAX_PROTO3"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Syntax `proto2`.",
|
| + "Syntax `proto3`."
|
| + ],
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "LabelDescriptor": {
|
| + "description": "A description of a label.",
|
| + "id": "LabelDescriptor",
|
| + "properties": {
|
| + "key": {
|
| + "description": "The label key.",
|
| + "type": "string"
|
| },
|
| - "logging": {
|
| - "$ref": "Logging",
|
| - "description": "Logging configuration."
|
| + "description": {
|
| + "description": "A human-readable description for the label.",
|
| + "type": "string"
|
| },
|
| - "monitoredResources": {
|
| - "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
|
| - "items": {
|
| - "$ref": "MonitoredResourceDescriptor"
|
| - },
|
| - "type": "array"
|
| + "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"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "EnableServiceRequest": {
|
| + "description": "Request message for EnableService method.",
|
| + "id": "EnableServiceRequest",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "Type": {
|
| + "description": "A protocol buffer message type.",
|
| + "id": "Type",
|
| + "properties": {
|
| + "name": {
|
| + "description": "The fully qualified message name.",
|
| + "type": "string"
|
| },
|
| - "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",
|
| + "oneofs": {
|
| + "description": "The list of types appearing in `oneof` definitions in this type.",
|
| "items": {
|
| - "$ref": "Enum"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "context": {
|
| - "$ref": "Context",
|
| - "description": "Context configuration."
|
| + "sourceContext": {
|
| + "$ref": "SourceContext",
|
| + "description": "The source context."
|
| },
|
| - "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.",
|
| + "syntax": {
|
| + "description": "The source syntax.",
|
| + "enum": [
|
| + "SYNTAX_PROTO2",
|
| + "SYNTAX_PROTO3"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Syntax `proto2`.",
|
| + "Syntax `proto3`."
|
| + ],
|
| "type": "string"
|
| },
|
| - "usage": {
|
| - "$ref": "Usage",
|
| - "description": "Configuration controlling usage of this service."
|
| - },
|
| - "metrics": {
|
| - "description": "Defines the metrics used by this service.",
|
| + "options": {
|
| + "description": "The protocol buffer options.",
|
| "items": {
|
| - "$ref": "MetricDescriptor"
|
| + "$ref": "Option"
|
| },
|
| "type": "array"
|
| },
|
| - "authentication": {
|
| - "$ref": "Authentication",
|
| - "description": "Auth configuration."
|
| - },
|
| - "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"
|
| - },
|
| - "monitoring": {
|
| - "$ref": "Monitoring",
|
| - "description": "Monitoring configuration."
|
| - },
|
| - "producerProjectId": {
|
| - "description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration,\nmanage consumption of the service, etc.",
|
| - "type": "string"
|
| - },
|
| - "systemTypes": {
|
| - "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
|
| + "fields": {
|
| + "description": "The list of fields.",
|
| "items": {
|
| - "$ref": "Type"
|
| + "$ref": "Field"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "OperationMetadata": {
|
| - "description": "The metadata associated with a long running operation resource.",
|
| - "id": "OperationMetadata",
|
| + "Experimental": {
|
| + "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
|
| + "id": "Experimental",
|
| "properties": {
|
| - "startTime": {
|
| - "description": "The start time of the operation.",
|
| - "format": "google-datetime",
|
| - "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.",
|
| + "authorization": {
|
| + "$ref": "AuthorizationConfig",
|
| + "description": "Authorization configuration."
|
| + }
|
| + },
|
| + "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": "Step"
|
| + "$ref": "BackendRule"
|
| },
|
| "type": "array"
|
| - },
|
| - "progressPercentage": {
|
| - "description": "Percentage of completion of this operation, ranging from 0 to 100.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CustomHttpPattern": {
|
| - "description": "A custom pattern is used for defining custom HTTP verb.",
|
| - "id": "CustomHttpPattern",
|
| + "DocumentationRule": {
|
| + "description": "A documentation rule provides information about individual API elements.",
|
| + "id": "DocumentationRule",
|
| "properties": {
|
| - "path": {
|
| - "description": "The path matched by this custom verb.",
|
| + "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"
|
| },
|
| - "kind": {
|
| - "description": "The name of this custom HTTP verb.",
|
| + "description": {
|
| + "description": "Description of the selected API(s).",
|
| + "type": "string"
|
| + },
|
| + "deprecationDescription": {
|
| + "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SystemParameterRule": {
|
| - "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
|
| - "id": "SystemParameterRule",
|
| + "AuthorizationConfig": {
|
| + "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
|
| + "id": "AuthorizationConfig",
|
| + "properties": {
|
| + "provider": {
|
| + "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ContextRule": {
|
| + "description": "A context rule provides information about the context for an individual API\nelement.",
|
| + "id": "ContextRule",
|
| "properties": {
|
| "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 the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| "type": "string"
|
| },
|
| - "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.",
|
| + "provided": {
|
| + "description": "A list of full type names of provided contexts.",
|
| "items": {
|
| - "$ref": "SystemParameter"
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "requested": {
|
| + "description": "A list of full type names of requested contexts.",
|
| + "items": {
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "PublishedService": {
|
| - "description": "The published version of a Service that is managed by\nGoogle Service Management.",
|
| - "id": "PublishedService",
|
| + "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 service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com",
|
| + "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"
|
| },
|
| - "service": {
|
| - "$ref": "Service",
|
| - "description": "The service's published configuration."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "HttpRule": {
|
| - "description": "`HttpRule` defines the mapping of an RPC method to one 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 request. 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 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 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 assumes there is no HTTP 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. 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) Section 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;\nthis 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 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 the\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 provide\ncontent to Web (HTML) clients.",
|
| - "id": "HttpRule",
|
| - "properties": {
|
| - "additionalBindings": {
|
| - "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
|
| - "items": {
|
| - "$ref": "HttpRule"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "responseBody": {
|
| - "description": "The name of the response field whose value is 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.",
|
| - "type": "string"
|
| - },
|
| - "mediaUpload": {
|
| - "$ref": "MediaUpload",
|
| - "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
|
| - },
|
| - "selector": {
|
| - "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| - "type": "string"
|
| - },
|
| - "custom": {
|
| - "$ref": "CustomHttpPattern",
|
| - "description": "Custom pattern is used for defining custom verbs."
|
| - },
|
| - "get": {
|
| - "description": "Used for listing and getting information about resources.",
|
| + "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"
|
| },
|
| - "patch": {
|
| - "description": "Used for updating a resource.",
|
| + "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"
|
| },
|
| - "put": {
|
| - "description": "Used for updating a resource.",
|
| + "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": [
|
| + "METRIC_KIND_UNSPECIFIED",
|
| + "GAUGE",
|
| + "DELTA",
|
| + "CUMULATIVE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Do not use this default value.",
|
| + "An instantaneous measurement of a value.",
|
| + "The change in a value during a time interval.",
|
| + "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
|
| + ],
|
| "type": "string"
|
| },
|
| - "delete": {
|
| - "description": "Used for deleting a resource.",
|
| + "displayName": {
|
| + "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".",
|
| "type": "string"
|
| },
|
| - "body": {
|
| - "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.",
|
| + "description": {
|
| + "description": "A detailed description of the metric, which can be used in documentation.",
|
| "type": "string"
|
| },
|
| - "post": {
|
| - "description": "Used for creating a resource.",
|
| + "unit": {
|
| + "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
|
| "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."
|
| + "labels": {
|
| + "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
|
| + "items": {
|
| + "$ref": "LabelDescriptor"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "VisibilityRule": {
|
| - "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
|
| - "id": "VisibilityRule",
|
| + "SourceContext": {
|
| + "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
|
| + "id": "SourceContext",
|
| "properties": {
|
| - "selector": {
|
| - "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
|
| - "type": "string"
|
| - },
|
| - "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.",
|
| + "fileName": {
|
| + "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MonitoringDestination": {
|
| - "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
|
| - "id": "MonitoringDestination",
|
| + "Endpoint": {
|
| + "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": {
|
| - "monitoredResource": {
|
| - "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
|
| - "type": "string"
|
| - },
|
| - "metrics": {
|
| - "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
|
| + "apis": {
|
| + "description": "The list of APIs served by this endpoint.",
|
| "items": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Visibility": {
|
| - "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
|
| - "id": "Visibility",
|
| - "properties": {
|
| - "rules": {
|
| - "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| - "items": {
|
| - "$ref": "VisibilityRule"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "SystemParameters": {
|
| - "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual 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 parameters.",
|
| - "id": "SystemParameters",
|
| - "properties": {
|
| - "rules": {
|
| - "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\nExample: 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_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| + },
|
| + "aliases": {
|
| + "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
|
| "items": {
|
| - "$ref": "SystemParameterRule"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Step": {
|
| - "description": "Represents the status of one operation step.",
|
| - "id": "Step",
|
| - "properties": {
|
| - "description": {
|
| - "description": "The short description of the step.",
|
| + },
|
| + "allowCors": {
|
| + "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
|
| + "type": "boolean"
|
| + },
|
| + "name": {
|
| + "description": "The canonical name of this endpoint.",
|
| "type": "string"
|
| },
|
| - "status": {
|
| - "description": "The status code.",
|
| - "enum": [
|
| - "STATUS_UNSPECIFIED",
|
| - "DONE",
|
| - "NOT_STARTED",
|
| - "IN_PROGRESS",
|
| - "FAILED",
|
| - "CANCELLED"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Unspecifed code.",
|
| - "The operation or step has completed without errors.",
|
| - "The operation or step has not started yet.",
|
| - "The operation or step is in progress.",
|
| - "The operation or step has completed with errors.",
|
| - "The operation or step has completed with cancellation."
|
| - ],
|
| + "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"
|
| + },
|
| + "features": {
|
| + "description": "The list of features enabled on this endpoint.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "LoggingDestination": {
|
| - "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
|
| - "id": "LoggingDestination",
|
| + "ListEnabledServicesResponse": {
|
| + "description": "Response message for `ListEnabledServices` method.",
|
| + "id": "ListEnabledServicesResponse",
|
| "properties": {
|
| - "logs": {
|
| - "description": "Names of the logs to be sent to this destination. 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 \"/\".",
|
| + "services": {
|
| + "description": "Services enabled for the specified parent.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "PublishedService"
|
| },
|
| "type": "array"
|
| },
|
| - "monitoredResource": {
|
| - "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
|
| + "nextPageToken": {
|
| + "description": "Token that can be passed to `ListEnabledServices` to resume a paginated\nquery.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Option": {
|
| - "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
|
| - "id": "Option",
|
| + "OAuthRequirements": {
|
| + "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
|
| + "id": "OAuthRequirements",
|
| "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\"`.",
|
| + "canonicalScopes": {
|
| + "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
|
| "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",
|
| + "Usage": {
|
| + "description": "Configuration controlling usage of a service.",
|
| + "id": "Usage",
|
| "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.",
|
| + "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"
|
| + },
|
| + "rules": {
|
| + "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "$ref": "LoggingDestination"
|
| + "$ref": "UsageRule"
|
| },
|
| "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.",
|
| + "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": {
|
| - "$ref": "LoggingDestination"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Method": {
|
| - "description": "Method represents a method of an api.",
|
| - "id": "Method",
|
| - "properties": {
|
| - "responseTypeUrl": {
|
| - "description": "The URL of the output message type.",
|
| - "type": "string"
|
| - },
|
| - "options": {
|
| - "description": "Any metadata attached to the method.",
|
| + "Context": {
|
| + "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
|
| + "id": "Context",
|
| + "properties": {
|
| + "rules": {
|
| + "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "$ref": "Option"
|
| + "$ref": "ContextRule"
|
| },
|
| "type": "array"
|
| - },
|
| - "responseStreaming": {
|
| - "description": "If true, the response is streamed.",
|
| - "type": "boolean"
|
| - },
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "LogDescriptor": {
|
| + "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": {
|
| "name": {
|
| - "description": "The simple name of this method.",
|
| + "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"
|
| },
|
| - "requestTypeUrl": {
|
| - "description": "A URL of the input message type.",
|
| + "description": {
|
| + "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
|
| "type": "string"
|
| },
|
| - "requestStreaming": {
|
| - "description": "If true, the request is streamed.",
|
| - "type": "boolean"
|
| - },
|
| - "syntax": {
|
| - "description": "The source syntax of this method.",
|
| - "enum": [
|
| - "SYNTAX_PROTO2",
|
| - "SYNTAX_PROTO3"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Syntax `proto2`.",
|
| - "Syntax `proto3`."
|
| - ],
|
| + "displayName": {
|
| + "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
|
| "type": "string"
|
| + },
|
| + "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"
|
| }
|
| },
|
| "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",
|
| + "CustomErrorRule": {
|
| + "description": "A custom error rule.",
|
| + "id": "CustomErrorRule",
|
| "properties": {
|
| - "name": {
|
| - "description": "The fully qualified name of the API which is included.",
|
| + "selector": {
|
| + "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
|
| "type": "string"
|
| },
|
| - "root": {
|
| - "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
|
| - "type": "string"
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CustomError": {
|
| - "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
|
| - "id": "CustomError",
|
| + "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": {
|
| - "types": {
|
| - "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "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"
|
| },
|
| - "rules": {
|
| - "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| + "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.",
|
| + "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\"`.",
|
| "items": {
|
| - "$ref": "CustomErrorRule"
|
| + "$ref": "LabelDescriptor"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Http": {
|
| - "description": "Defines the HTTP configuration for a 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",
|
| + "MediaDownload": {
|
| + "description": "Use 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": {
|
| - "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"
|
| + "enabled": {
|
| + "description": "Whether download is enabled.",
|
| + "type": "boolean"
|
| + },
|
| + "downloadService": {
|
| + "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SourceInfo": {
|
| - "description": "Source information used to create a Service Config",
|
| - "id": "SourceInfo",
|
| + "DisableServiceRequest": {
|
| + "description": "Request message for DisableService method.",
|
| + "id": "DisableServiceRequest",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "SearchServicesResponse": {
|
| + "description": "Response message for SearchServices method.",
|
| + "id": "SearchServicesResponse",
|
| "properties": {
|
| - "sourceFiles": {
|
| - "description": "All files used during config generation.",
|
| + "services": {
|
| + "description": "Services available publicly or available to the authenticated caller.",
|
| "items": {
|
| - "additionalProperties": {
|
| - "description": "Properties of the object. Contains field @type with type URL.",
|
| - "type": "any"
|
| - },
|
| - "type": "object"
|
| + "$ref": "PublishedService"
|
| },
|
| "type": "array"
|
| + },
|
| + "nextPageToken": {
|
| + "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Control": {
|
| - "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
|
| - "id": "Control",
|
| + "MediaUpload": {
|
| + "description": "Use 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": {
|
| - "environment": {
|
| - "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
|
| + "enabled": {
|
| + "description": "Whether upload is enabled.",
|
| + "type": "boolean"
|
| + },
|
| + "uploadService": {
|
| + "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "SystemParameter": {
|
| - "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
|
| - "id": "SystemParameter",
|
| + "UsageRule": {
|
| + "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
|
| + "id": "UsageRule",
|
| "properties": {
|
| - "urlQueryParameter": {
|
| - "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
|
| + "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"
|
| },
|
| - "httpHeader": {
|
| - "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
|
| + "allowUnregisteredCalls": {
|
| + "description": "True, if the method allows unregistered calls; false otherwise.",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "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"
|
| },
|
| - "name": {
|
| - "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
|
| + "providerId": {
|
| + "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Field": {
|
| - "description": "A single field of a message type.",
|
| - "id": "Field",
|
| + "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",
|
| "properties": {
|
| - "name": {
|
| - "description": "The field name.",
|
| + "summary": {
|
| + "description": "A short summary of what the service does. Can only be provided by\nplain text.",
|
| "type": "string"
|
| },
|
| - "typeUrl": {
|
| - "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
|
| + "documentationRootUrl": {
|
| + "description": "The URL to the root of documentation.",
|
| "type": "string"
|
| },
|
| - "number": {
|
| - "description": "The field number.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| + "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": {
|
| + "$ref": "DocumentationRule"
|
| + },
|
| + "type": "array"
|
| },
|
| - "jsonName": {
|
| - "description": "The field JSON name.",
|
| + "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"
|
| },
|
| - "kind": {
|
| - "description": "The field type.",
|
| - "enum": [
|
| - "TYPE_UNKNOWN",
|
| - "TYPE_DOUBLE",
|
| - "TYPE_FLOAT",
|
| - "TYPE_INT64",
|
| - "TYPE_UINT64",
|
| - "TYPE_INT32",
|
| - "TYPE_FIXED64",
|
| - "TYPE_FIXED32",
|
| - "TYPE_BOOL",
|
| - "TYPE_STRING",
|
| - "TYPE_GROUP",
|
| - "TYPE_MESSAGE",
|
| - "TYPE_BYTES",
|
| - "TYPE_UINT32",
|
| - "TYPE_ENUM",
|
| - "TYPE_SFIXED32",
|
| - "TYPE_SFIXED64",
|
| - "TYPE_SINT32",
|
| - "TYPE_SINT64"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Field type unknown.",
|
| - "Field type double.",
|
| - "Field type float.",
|
| - "Field type int64.",
|
| - "Field type uint64.",
|
| - "Field type int32.",
|
| - "Field type fixed64.",
|
| - "Field type fixed32.",
|
| - "Field type bool.",
|
| - "Field type string.",
|
| - "Field type group. Proto2 syntax only, and deprecated.",
|
| - "Field type message.",
|
| - "Field type bytes.",
|
| - "Field type uint32.",
|
| - "Field type enum.",
|
| - "Field type sfixed32.",
|
| - "Field type sfixed64.",
|
| - "Field type sint32.",
|
| - "Field type sint64."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "options": {
|
| - "description": "The protocol buffer options.",
|
| + "pages": {
|
| + "description": "The top level pages for the documentation set.",
|
| "items": {
|
| - "$ref": "Option"
|
| + "$ref": "Page"
|
| },
|
| "type": "array"
|
| - },
|
| - "oneofIndex": {
|
| - "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "cardinality": {
|
| - "description": "The field cardinality.",
|
| - "enum": [
|
| - "CARDINALITY_UNKNOWN",
|
| - "CARDINALITY_OPTIONAL",
|
| - "CARDINALITY_REQUIRED",
|
| - "CARDINALITY_REPEATED"
|
| - ],
|
| - "enumDescriptions": [
|
| - "For fields with unknown cardinality.",
|
| - "For optional fields.",
|
| - "For required fields. Proto2 syntax only.",
|
| - "For repeated fields."
|
| - ],
|
| - "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"
|
| }
|
| },
|
| "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",
|
| + "AuthenticationRule": {
|
| + "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": {
|
| - "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.",
|
| + "requirements": {
|
| + "description": "Requirements for additional authentication providers.",
|
| "items": {
|
| - "$ref": "MonitoringDestination"
|
| + "$ref": "AuthRequirement"
|
| },
|
| "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"
|
| - },
|
| - "Enum": {
|
| - "description": "Enum type definition.",
|
| - "id": "Enum",
|
| - "properties": {
|
| - "name": {
|
| - "description": "Enum type name.",
|
| + "selector": {
|
| + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| "type": "string"
|
| },
|
| - "enumvalue": {
|
| - "description": "Enum value definitions.",
|
| - "items": {
|
| - "$ref": "EnumValue"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "options": {
|
| - "description": "Protocol buffer options.",
|
| - "items": {
|
| - "$ref": "Option"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "sourceContext": {
|
| - "$ref": "SourceContext",
|
| - "description": "The source context."
|
| + "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"
|
| },
|
| - "syntax": {
|
| - "description": "The source syntax.",
|
| - "enum": [
|
| - "SYNTAX_PROTO2",
|
| - "SYNTAX_PROTO3"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Syntax `proto2`.",
|
| - "Syntax `proto3`."
|
| - ],
|
| - "type": "string"
|
| + "oauth": {
|
| + "$ref": "OAuthRequirements",
|
| + "description": "The requirements for OAuth credentials."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "EnableServiceRequest": {
|
| - "description": "Request message for EnableService method.",
|
| - "id": "EnableServiceRequest",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "LabelDescriptor": {
|
| - "description": "A description of a label.",
|
| - "id": "LabelDescriptor",
|
| + "BackendRule": {
|
| + "description": "A backend rule provides configuration for an individual API element.",
|
| + "id": "BackendRule",
|
| "properties": {
|
| - "key": {
|
| - "description": "The label key.",
|
| + "selector": {
|
| + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| "type": "string"
|
| },
|
| - "description": {
|
| - "description": "A human-readable description for the label.",
|
| - "type": "string"
|
| + "deadline": {
|
| + "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
|
| + "format": "double",
|
| + "type": "number"
|
| },
|
| - "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."
|
| - ],
|
| + "address": {
|
| + "description": "The address of the API backend.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Type": {
|
| - "description": "A protocol buffer message type.",
|
| - "id": "Type",
|
| + "Api": {
|
| + "description": "Api is a light-weight descriptor for a protocol buffer service.",
|
| + "id": "Api",
|
| "properties": {
|
| + "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"
|
| + },
|
| + "mixins": {
|
| + "description": "Included APIs. See Mixin.",
|
| + "items": {
|
| + "$ref": "Mixin"
|
| + },
|
| + "type": "array"
|
| + },
|
| "options": {
|
| - "description": "The protocol buffer options.",
|
| + "description": "Any metadata attached to the API.",
|
| "items": {
|
| "$ref": "Option"
|
| },
|
| "type": "array"
|
| },
|
| - "fields": {
|
| - "description": "The list of fields.",
|
| + "methods": {
|
| + "description": "The methods of this api, in unspecified order.",
|
| "items": {
|
| - "$ref": "Field"
|
| + "$ref": "Method"
|
| },
|
| "type": "array"
|
| },
|
| "name": {
|
| - "description": "The fully qualified message name.",
|
| + "description": "The fully qualified name of this api, including package name\nfollowed by the api's simple name.",
|
| "type": "string"
|
| },
|
| - "oneofs": {
|
| - "description": "The list of types appearing in `oneof` definitions in this type.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| "syntax": {
|
| - "description": "The source syntax.",
|
| + "description": "The source syntax of the service.",
|
| "enum": [
|
| "SYNTAX_PROTO2",
|
| "SYNTAX_PROTO3"
|
| @@ -1384,398 +1318,570 @@
|
| },
|
| "sourceContext": {
|
| "$ref": "SourceContext",
|
| - "description": "The source context."
|
| + "description": "Source context for the protocol buffer service represented by this\nmessage."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Experimental": {
|
| - "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
|
| - "id": "Experimental",
|
| + "MetricRule": {
|
| + "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota, billing, and monitoring behaviors to apply to the\nmethod call.\n\nUsed by metric-based quotas only.",
|
| + "id": "MetricRule",
|
| "properties": {
|
| - "authorization": {
|
| - "$ref": "AuthorizationConfig",
|
| - "description": "Authorization configuration."
|
| + "selector": {
|
| + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "type": "string"
|
| + },
|
| + "metricCosts": {
|
| + "additionalProperties": {
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Backend": {
|
| - "description": "`Backend` defines the backend configuration for a service.",
|
| - "id": "Backend",
|
| + "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",
|
| "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.",
|
| + "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "$ref": "BackendRule"
|
| + "$ref": "AuthenticationRule"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "providers": {
|
| + "description": "Defines a set of authentication providers that a service supports.",
|
| + "items": {
|
| + "$ref": "AuthProvider"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "DocumentationRule": {
|
| - "description": "A documentation rule provides information about individual API elements.",
|
| - "id": "DocumentationRule",
|
| + "Operation": {
|
| + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
|
| + "id": "Operation",
|
| "properties": {
|
| - "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.",
|
| + "name": {
|
| + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
|
| "type": "string"
|
| },
|
| - "description": {
|
| - "description": "Description of the selected API(s).",
|
| - "type": "string"
|
| + "error": {
|
| + "$ref": "Status",
|
| + "description": "The error result of the operation in case of failure or cancellation."
|
| },
|
| - "deprecationDescription": {
|
| - "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
|
| - "type": "string"
|
| + "metadata": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
|
| + "type": "object"
|
| + },
|
| + "done": {
|
| + "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
|
| + "type": "boolean"
|
| + },
|
| + "response": {
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
|
| + "type": "object"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AuthorizationConfig": {
|
| - "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
|
| - "id": "AuthorizationConfig",
|
| + "Page": {
|
| + "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
|
| + "id": "Page",
|
| "properties": {
|
| - "provider": {
|
| - "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
|
| + "name": {
|
| + "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n<pre><code>pages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n</code></pre>\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
|
| "type": "string"
|
| + },
|
| + "content": {
|
| + "description": "The Markdown content of the page. You can use <code>(== include {path} ==)</code>\nto include content from a Markdown file.",
|
| + "type": "string"
|
| + },
|
| + "subpages": {
|
| + "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
|
| + "items": {
|
| + "$ref": "Page"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ContextRule": {
|
| - "description": "A context rule provides information about the context for an individual API\nelement.",
|
| - "id": "ContextRule",
|
| + "Status": {
|
| + "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which 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 purpose.\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": {
|
| - "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.",
|
| + "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"
|
| },
|
| - "provided": {
|
| - "description": "A list of full type names of provided contexts.",
|
| + "details": {
|
| + "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
|
| "items": {
|
| - "type": "string"
|
| + "additionalProperties": {
|
| + "description": "Properties of the object. Contains field @type with type URL.",
|
| + "type": "any"
|
| + },
|
| + "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"
|
| },
|
| - "SourceContext": {
|
| - "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
|
| - "id": "SourceContext",
|
| + "AuthProvider": {
|
| + "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": {
|
| - "fileName": {
|
| - "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
|
| + "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"
|
| },
|
| - "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",
|
| + "EnumValue": {
|
| + "description": "Enum value definition.",
|
| + "id": "EnumValue",
|
| "properties": {
|
| - "unit": {
|
| - "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
|
| + "number": {
|
| + "description": "Enum value number.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "name": {
|
| + "description": "Enum value name.",
|
| "type": "string"
|
| },
|
| - "labels": {
|
| - "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
|
| + "options": {
|
| + "description": "Protocol buffer options.",
|
| "items": {
|
| - "$ref": "LabelDescriptor"
|
| + "$ref": "Option"
|
| },
|
| "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Service": {
|
| + "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": {
|
| + "customError": {
|
| + "$ref": "CustomError",
|
| + "description": "Custom error configuration."
|
| },
|
| - "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\"",
|
| + "title": {
|
| + "description": "The product title associated with this service.",
|
| "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"
|
| + "endpoints": {
|
| + "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
|
| + "items": {
|
| + "$ref": "Endpoint"
|
| + },
|
| + "type": "array"
|
| },
|
| - "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"
|
| + "logs": {
|
| + "description": "Defines the logs used by this service.",
|
| + "items": {
|
| + "$ref": "LogDescriptor"
|
| + },
|
| + "type": "array"
|
| },
|
| - "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": [
|
| - "METRIC_KIND_UNSPECIFIED",
|
| - "GAUGE",
|
| - "DELTA",
|
| - "CUMULATIVE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Do not use this default value.",
|
| - "An instantaneous measurement of a value.",
|
| - "The change in a value during a time interval.",
|
| - "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
|
| - ],
|
| - "type": "string"
|
| + "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": "Api"
|
| + },
|
| + "type": "array"
|
| },
|
| - "description": {
|
| - "description": "A detailed description of the metric, which can be used in documentation.",
|
| + "types": {
|
| + "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
|
| + "items": {
|
| + "$ref": "Type"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "sourceInfo": {
|
| + "$ref": "SourceInfo",
|
| + "description": "Output only. The source information for this configuration if available."
|
| + },
|
| + "http": {
|
| + "$ref": "Http",
|
| + "description": "HTTP configuration."
|
| + },
|
| + "systemParameters": {
|
| + "$ref": "SystemParameters",
|
| + "description": "System parameter configuration."
|
| + },
|
| + "backend": {
|
| + "$ref": "Backend",
|
| + "description": "API backend configuration."
|
| + },
|
| + "documentation": {
|
| + "$ref": "Documentation",
|
| + "description": "Additional API documentation."
|
| + },
|
| + "logging": {
|
| + "$ref": "Logging",
|
| + "description": "Logging configuration."
|
| + },
|
| + "monitoredResources": {
|
| + "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
|
| + "items": {
|
| + "$ref": "MonitoredResourceDescriptor"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "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": {
|
| + "$ref": "Enum"
|
| + },
|
| + "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"
|
| },
|
| - "displayName": {
|
| - "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".",
|
| + "usage": {
|
| + "$ref": "Usage",
|
| + "description": "Configuration controlling usage of this service."
|
| + },
|
| + "metrics": {
|
| + "description": "Defines the metrics used by this service.",
|
| + "items": {
|
| + "$ref": "MetricDescriptor"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "authentication": {
|
| + "$ref": "Authentication",
|
| + "description": "Auth configuration."
|
| + },
|
| + "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"
|
| + },
|
| + "monitoring": {
|
| + "$ref": "Monitoring",
|
| + "description": "Monitoring configuration."
|
| + },
|
| + "producerProjectId": {
|
| + "description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration,\nmanage consumption of the service, etc.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListEnabledServicesResponse": {
|
| - "description": "Response message for `ListEnabledServices` method.",
|
| - "id": "ListEnabledServicesResponse",
|
| - "properties": {
|
| - "services": {
|
| - "description": "Services enabled for the specified parent.",
|
| + },
|
| + "systemTypes": {
|
| + "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
|
| "items": {
|
| - "$ref": "PublishedService"
|
| + "$ref": "Type"
|
| },
|
| "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "Token that can be passed to `ListEnabledServices` to resume a paginated\nquery.",
|
| + "visibility": {
|
| + "$ref": "Visibility",
|
| + "description": "API visibility configuration."
|
| + },
|
| + "quota": {
|
| + "$ref": "Quota",
|
| + "description": "Quota configuration."
|
| + },
|
| + "name": {
|
| + "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Endpoint": {
|
| - "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",
|
| + "OperationMetadata": {
|
| + "description": "The metadata associated with a long running operation resource.",
|
| + "id": "OperationMetadata",
|
| "properties": {
|
| - "aliases": {
|
| - "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "startTime": {
|
| + "description": "The start time of the operation.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| },
|
| - "features": {
|
| - "description": "The list of features enabled on this endpoint.",
|
| + "resourceNames": {
|
| + "description": "The full name of the resources that this operation is directly\nassociated with.",
|
| "items": {
|
| "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "allowCors": {
|
| - "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
|
| - "type": "boolean"
|
| - },
|
| - "name": {
|
| - "description": "The canonical name of this endpoint.",
|
| - "type": "string"
|
| - },
|
| - "apis": {
|
| - "description": "The list of APIs served by this endpoint.",
|
| + "steps": {
|
| + "description": "Detailed status information for each step. The order is undetermined.",
|
| "items": {
|
| - "type": "string"
|
| + "$ref": "Step"
|
| },
|
| "type": "array"
|
| + },
|
| + "progressPercentage": {
|
| + "description": "Percentage of completion of this operation, ranging from 0 to 100.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "OAuthRequirements": {
|
| - "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
|
| - "id": "OAuthRequirements",
|
| + "CustomHttpPattern": {
|
| + "description": "A custom pattern is used for defining custom HTTP verb.",
|
| + "id": "CustomHttpPattern",
|
| "properties": {
|
| - "canonicalScopes": {
|
| - "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
|
| + "path": {
|
| + "description": "The path matched by this custom verb.",
|
| + "type": "string"
|
| + },
|
| + "kind": {
|
| + "description": "The name of this custom HTTP verb.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Usage": {
|
| - "description": "Configuration controlling usage of a service.",
|
| - "id": "Usage",
|
| + "PublishedService": {
|
| + "description": "The published version of a Service that is managed by\nGoogle Service Management.",
|
| + "id": "PublishedService",
|
| "properties": {
|
| - "rules": {
|
| - "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| - "items": {
|
| - "$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"
|
| + "service": {
|
| + "$ref": "Service",
|
| + "description": "The service's published configuration."
|
| },
|
| - "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.",
|
| + "name": {
|
| + "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Context": {
|
| - "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
|
| - "id": "Context",
|
| + "SystemParameterRule": {
|
| + "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
|
| + "id": "SystemParameterRule",
|
| "properties": {
|
| - "rules": {
|
| - "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| + "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": "ContextRule"
|
| + "$ref": "SystemParameter"
|
| },
|
| "type": "array"
|
| + },
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "LogDescriptor": {
|
| - "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",
|
| + "HttpRule": {
|
| + "description": "`HttpRule` defines the mapping of an RPC method to one 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 request. 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 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 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 assumes there is no HTTP 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. 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) Section 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;\nthis 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 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 the\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 provide\ncontent to Web (HTML) clients.",
|
| + "id": "HttpRule",
|
| "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.",
|
| + "additionalBindings": {
|
| + "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
|
| "items": {
|
| - "$ref": "LabelDescriptor"
|
| + "$ref": "HttpRule"
|
| },
|
| "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 [/_-.].",
|
| + "responseBody": {
|
| + "description": "The name of the response field whose value is 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.",
|
| "type": "string"
|
| },
|
| - "description": {
|
| - "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
|
| + "mediaUpload": {
|
| + "$ref": "MediaUpload",
|
| + "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
|
| + },
|
| + "selector": {
|
| + "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
|
| "type": "string"
|
| },
|
| - "displayName": {
|
| - "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
|
| + "custom": {
|
| + "$ref": "CustomHttpPattern",
|
| + "description": "Custom pattern is used for defining custom verbs."
|
| + },
|
| + "get": {
|
| + "description": "Used for listing and getting information about resources.",
|
| "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}\"`.",
|
| + "patch": {
|
| + "description": "Used for updating a resource.",
|
| "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\"`.",
|
| + "put": {
|
| + "description": "Used for updating a resource.",
|
| "type": "string"
|
| },
|
| - "description": {
|
| - "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
|
| + "delete": {
|
| + "description": "Used for deleting a resource.",
|
| "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.",
|
| + "body": {
|
| + "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."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CustomErrorRule": {
|
| - "description": "A custom error rule.",
|
| - "id": "CustomErrorRule",
|
| + "VisibilityRule": {
|
| + "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
|
| + "id": "VisibilityRule",
|
| "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.",
|
| + "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
|
| + "type": "string"
|
| + },
|
| + "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"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MediaDownload": {
|
| - "description": "Use 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",
|
| + "MonitoringDestination": {
|
| + "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
|
| + "id": "MonitoringDestination",
|
| "properties": {
|
| - "enabled": {
|
| - "description": "Whether download is enabled.",
|
| - "type": "boolean"
|
| - },
|
| - "downloadService": {
|
| - "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
|
| + "monitoredResource": {
|
| + "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
|
| "type": "string"
|
| + },
|
| + "metrics": {
|
| + "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "DisableServiceRequest": {
|
| - "description": "Request message for DisableService method.",
|
| - "id": "DisableServiceRequest",
|
| - "properties": {},
|
| + "Visibility": {
|
| + "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
|
| + "id": "Visibility",
|
| + "properties": {
|
| + "rules": {
|
| + "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| + "items": {
|
| + "$ref": "VisibilityRule"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| "type": "object"
|
| },
|
| - "SearchServicesResponse": {
|
| - "description": "Response message for SearchServices method.",
|
| - "id": "SearchServicesResponse",
|
| + "SystemParameters": {
|
| + "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual 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 parameters.",
|
| + "id": "SystemParameters",
|
| "properties": {
|
| - "services": {
|
| - "description": "Services available publicly or available to the authenticated caller.",
|
| + "rules": {
|
| + "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\nExample: 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_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
|
| "items": {
|
| - "$ref": "PublishedService"
|
| + "$ref": "SystemParameterRule"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Quota": {
|
| + "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
|
| + "id": "Quota",
|
| + "properties": {
|
| + "limits": {
|
| + "description": "List of `QuotaLimit` definitions for the service.\n\nUsed by metric-based quotas only.",
|
| + "items": {
|
| + "$ref": "QuotaLimit"
|
| },
|
| "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
|
| - "type": "string"
|
| + "metricRules": {
|
| + "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.\n\nUsed by metric-based quotas only.",
|
| + "items": {
|
| + "$ref": "MetricRule"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MediaUpload": {
|
| - "description": "Use 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",
|
| + "Step": {
|
| + "description": "Represents the status of one operation step.",
|
| + "id": "Step",
|
| "properties": {
|
| - "enabled": {
|
| - "description": "Whether upload is enabled.",
|
| - "type": "boolean"
|
| + "status": {
|
| + "description": "The status code.",
|
| + "enum": [
|
| + "STATUS_UNSPECIFIED",
|
| + "DONE",
|
| + "NOT_STARTED",
|
| + "IN_PROGRESS",
|
| + "FAILED",
|
| + "CANCELLED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Unspecifed code.",
|
| + "The operation or step has completed without errors.",
|
| + "The operation or step has not started yet.",
|
| + "The operation or step is in progress.",
|
| + "The operation or step has completed with errors.",
|
| + "The operation or step has completed with cancellation."
|
| + ],
|
| + "type": "string"
|
| },
|
| - "uploadService": {
|
| - "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
|
| + "description": {
|
| + "description": "The short description of the step.",
|
| "type": "string"
|
| }
|
| },
|
|
|
Chromium Code Reviews
Issue 2824163002:
Api-roll 48: 2017-04-18 (Closed)
