Api is a light-weight descriptor for a protocol buffer service.
Method represents a method of an api.
Method represents a method of an api.
The simple name of this method.
A URL of the input message type.
If true, the request is streamed.
The URL of the output message type.
If true, the response is streamed.
Any metadata attached to the method.
The source syntax of this method.
Declares an API to be included in this API.
Declares an API to be included in this API. The including API must redeclare all the methods from the included API, but documentation and options are inherited as follows:
- If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method.
- Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited.
- If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including API plus the [root][] path if specified.
Example of a simple mixin:
package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; } }
package google.storage.v2; service Storage { rpc GetAcl(GetAclRequest) returns (Acl);
// Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**}"; } }
Example of a mixin configuration:
apis:
The mixin construct implies that all methods in AccessControl
are
also declared with same name and request/response types in
Storage
. A documentation generator or annotation processor will
see the effective Storage.GetAcl
method after inherting
documentation and annotations as follows:
service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... }
Note how the version in the path pattern changed from v1
to v2
.
If the root
field in the mixin is specified, it should be a
relative path under which inherited HTTP paths are placed. Example:
apis:
This implies the following inherited HTTP annotation:
service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }
The fully qualified name of the API which is included.
If non-empty specifies a path under which inherited HTTP paths are rooted.
Api is a light-weight descriptor for a protocol buffer service.
The fully qualified name of this api, including package name followed by the api's simple name.
The methods of this api, in unspecified order.
Any metadata attached to the API.
A version string for this api. If specified, must have the form
major-version.minor-version
, as in1.10
. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the API, which must end inv<major-version>
, as ingoogle.feature.v1
. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, none-GA apis.Source context for the protocol buffer service represented by this message.
Included APIs. See [Mixin][].
The source syntax of the service.