Aharoni, Pavel (pa0916) | ca3cb01 | 2018-10-22 15:29:57 +0300 | [diff] [blame] | 1 | // Copyright 2018 Google LLC.
|
| 2 | //
|
| 3 | // Licensed under the Apache License, Version 2.0 (the "License");
|
| 4 | // you may not use this file except in compliance with the License.
|
| 5 | // You may obtain a copy of the License at
|
| 6 | //
|
| 7 | // http://www.apache.org/licenses/LICENSE-2.0
|
| 8 | //
|
| 9 | // Unless required by applicable law or agreed to in writing, software
|
| 10 | // distributed under the License is distributed on an "AS IS" BASIS,
|
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| 12 | // See the License for the specific language governing permissions and
|
| 13 | // limitations under the License.
|
| 14 | //
|
| 15 |
|
| 16 | syntax = "proto3";
|
| 17 |
|
| 18 | package google.api;
|
| 19 |
|
| 20 | option cc_enable_arenas = true;
|
| 21 | option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
|
| 22 | option java_multiple_files = true;
|
| 23 | option java_outer_classname = "HttpProto";
|
| 24 | option java_package = "com.google.api";
|
| 25 | option objc_class_prefix = "GAPI";
|
| 26 |
|
| 27 |
|
| 28 | // Defines the HTTP configuration for an API service. It contains a list of
|
| 29 | // [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method
|
| 30 | // to one or more HTTP REST API methods.
|
| 31 | message Http {
|
| 32 | // A list of HTTP configuration rules that apply to individual API methods.
|
| 33 | //
|
| 34 | // **NOTE:** All service configuration rules follow "last one wins" order.
|
| 35 | repeated HttpRule rules = 1;
|
| 36 |
|
| 37 | // When set to true, URL path parmeters will be fully URI-decoded except in
|
| 38 | // cases of single segment matches in reserved expansion, where "%2F" will be
|
| 39 | // left encoded.
|
| 40 | //
|
| 41 | // The default behavior is to not decode RFC 6570 reserved characters in multi
|
| 42 | // segment matches.
|
| 43 | bool fully_decode_reserved_expansion = 2;
|
| 44 | }
|
| 45 |
|
| 46 | // # gRPC Transcoding
|
| 47 | //
|
| 48 | // gRPC Transcoding is a feature for mapping between a gRPC method and one or
|
| 49 | // more HTTP REST endpoints. It allows developers to build a single API service
|
| 50 | // that supports both gRPC APIs and REST APIs. Many systems, including [Google
|
| 51 | // APIs](https://github.com/googleapis/googleapis),
|
| 52 | // [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
|
| 53 | // Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
|
| 54 | // and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
|
| 55 | // and use it for large scale production services.
|
| 56 | //
|
| 57 | // `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
|
| 58 | // how different portions of the gRPC request message are mapped to the URL
|
| 59 | // path, URL query parameters, and HTTP request body. It also controls how the
|
| 60 | // gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
| 61 | // typically specified as an `google.api.http` annotation on the gRPC method.
|
| 62 | //
|
| 63 | // Each mapping specifies a URL path template and an HTTP method. The path
|
| 64 | // template may refer to one or more fields in the gRPC request message, as long
|
| 65 | // as each field is a non-repeated field with a primitive (non-message) type.
|
| 66 | // The path template controls how fields of the request message are mapped to
|
| 67 | // the URL path.
|
| 68 | //
|
| 69 | // Example:
|
| 70 | //
|
| 71 | // service Messaging {
|
| 72 | // rpc GetMessage(GetMessageRequest) returns (Message) {
|
| 73 | // option (google.api.http) = {
|
| 74 | // get: "/v1/{name=messages/*"}"
|
| 75 | // };
|
| 76 | // }
|
| 77 | // }
|
| 78 | // message GetMessageRequest {
|
| 79 | // string name = 1; // Mapped to URL path.
|
| 80 | // }
|
| 81 | // message Message {
|
| 82 | // string text = 1; // The resource content.
|
| 83 | // }
|
| 84 | //
|
| 85 | // This enables an HTTP REST to gRPC mapping as below:
|
| 86 | //
|
| 87 | // HTTP | gRPC
|
| 88 | // -----|-----
|
| 89 | // `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
|
| 90 | //
|
| 91 | // Any fields in the request message which are not bound by the path template
|
| 92 | // automatically become HTTP query parameters if there is no HTTP request body.
|
| 93 | // For example:
|
| 94 | //
|
| 95 | // service Messaging {
|
| 96 | // rpc GetMessage(GetMessageRequest) returns (Message) {
|
| 97 | // option (google.api.http) = {
|
| 98 | // get:"/v1/messages/{message_id}"
|
| 99 | // };
|
| 100 | // }
|
| 101 | // }
|
| 102 | // message GetMessageRequest {
|
| 103 | // message SubMessage {
|
| 104 | // string subfield = 1;
|
| 105 | // }
|
| 106 | // string message_id = 1; // Mapped to URL path.
|
| 107 | // int64 revision = 2; // Mapped to URL query parameter `revision`.
|
| 108 | // SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
|
| 109 | // }
|
| 110 | //
|
| 111 | // This enables a HTTP JSON to RPC mapping as below:
|
| 112 | //
|
| 113 | // HTTP | gRPC
|
| 114 | // -----|-----
|
| 115 | // `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`
|
| 116 | //
|
| 117 | // Note that fields which are mapped to URL query parameters must have a
|
| 118 | // primitive type or a repeated primitive type or a non-repeated message type.
|
| 119 | // In the case of a repeated type, the parameter can be repeated in the URL
|
| 120 | // as `...?param=A¶m=B`. In the case of a message type, each field of the
|
| 121 | // message is mapped to a separate parameter, such as
|
| 122 | // `...?foo.a=A&foo.b=B&foo.c=C`.
|
| 123 | //
|
| 124 | // For HTTP methods that allow a request body, the `body` field
|
| 125 | // specifies the mapping. Consider a REST update method on the
|
| 126 | // message resource collection:
|
| 127 | //
|
| 128 | // service Messaging {
|
| 129 | // rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
|
| 130 | // option (google.api.http) = {
|
| 131 | // patch: "/v1/messages/{message_id}"
|
| 132 | // body: "message"
|
| 133 | // };
|
| 134 | // }
|
| 135 | // }
|
| 136 | // message UpdateMessageRequest {
|
| 137 | // string message_id = 1; // mapped to the URL
|
| 138 | // Message message = 2; // mapped to the body
|
| 139 | // }
|
| 140 | //
|
| 141 | // The following HTTP JSON to RPC mapping is enabled, where the
|
| 142 | // representation of the JSON in the request body is determined by
|
| 143 | // protos JSON encoding:
|
| 144 | //
|
| 145 | // HTTP | gRPC
|
| 146 | // -----|-----
|
| 147 | // `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
|
| 148 | //
|
| 149 | // The special name `*` can be used in the body mapping to define that
|
| 150 | // every field not bound by the path template should be mapped to the
|
| 151 | // request body. This enables the following alternative definition of
|
| 152 | // the update method:
|
| 153 | //
|
| 154 | // service Messaging {
|
| 155 | // rpc UpdateMessage(Message) returns (Message) {
|
| 156 | // option (google.api.http) = {
|
| 157 | // patch: "/v1/messages/{message_id}"
|
| 158 | // body: "*"
|
| 159 | // };
|
| 160 | // }
|
| 161 | // }
|
| 162 | // message Message {
|
| 163 | // string message_id = 1;
|
| 164 | // string text = 2;
|
| 165 | // }
|
| 166 | //
|
| 167 | //
|
| 168 | // The following HTTP JSON to RPC mapping is enabled:
|
| 169 | //
|
| 170 | // HTTP | gRPC
|
| 171 | // -----|-----
|
| 172 | // `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`
|
| 173 | //
|
| 174 | // Note that when using `*` in the body mapping, it is not possible to
|
| 175 | // have HTTP parameters, as all fields not bound by the path end in
|
| 176 | // the body. This makes this option more rarely used in practice when
|
| 177 | // defining REST APIs. The common usage of `*` is in custom methods
|
| 178 | // which don't use the URL at all for transferring data.
|
| 179 | //
|
| 180 | // It is possible to define multiple HTTP methods for one RPC by using
|
| 181 | // the `additional_bindings` option. Example:
|
| 182 | //
|
| 183 | // service Messaging {
|
| 184 | // rpc GetMessage(GetMessageRequest) returns (Message) {
|
| 185 | // option (google.api.http) = {
|
| 186 | // get: "/v1/messages/{message_id}"
|
| 187 | // additional_bindings {
|
| 188 | // get: "/v1/users/{user_id}/messages/{message_id}"
|
| 189 | // }
|
| 190 | // };
|
| 191 | // }
|
| 192 | // }
|
| 193 | // message GetMessageRequest {
|
| 194 | // string message_id = 1;
|
| 195 | // string user_id = 2;
|
| 196 | // }
|
| 197 | //
|
| 198 | // This enables the following two alternative HTTP JSON to RPC mappings:
|
| 199 | //
|
| 200 | // HTTP | gRPC
|
| 201 | // -----|-----
|
| 202 | // `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
|
| 203 | // `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`
|
| 204 | //
|
| 205 | // ## Rules for HTTP mapping
|
| 206 | //
|
| 207 | // 1. Leaf request fields (recursive expansion nested messages in the request
|
| 208 | // message) are classified into three categories:
|
| 209 | // - Fields referred by the path template. They are passed via the URL path.
|
| 210 | // - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP
|
| 211 | // request body.
|
| 212 | // - All other fields are passed via the URL query parameters, and the
|
| 213 | // parameter name is the field path in the request message. A repeated
|
| 214 | // field can be represented as multiple query parameters under the same
|
| 215 | // name.
|
| 216 | // 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields
|
| 217 | // are passed via URL path and HTTP request body.
|
| 218 | // 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all
|
| 219 | // fields are passed via URL path and URL query parameters.
|
| 220 | //
|
| 221 | // ### Path template syntax
|
| 222 | //
|
| 223 | // Template = "/" Segments [ Verb ] ;
|
| 224 | // Segments = Segment { "/" Segment } ;
|
| 225 | // Segment = "*" | "**" | LITERAL | Variable ;
|
| 226 | // Variable = "{" FieldPath [ "=" Segments ] "}" ;
|
| 227 | // FieldPath = IDENT { "." IDENT } ;
|
| 228 | // Verb = ":" LITERAL ;
|
| 229 | //
|
| 230 | // The syntax `*` matches a single URL path segment. The syntax `**` matches
|
| 231 | // zero or more URL path segments, which must be the last part of the URL path
|
| 232 | // except the `Verb`.
|
| 233 | //
|
| 234 | // The syntax `Variable` matches part of the URL path as specified by its
|
| 235 | // template. A variable template must not contain other variables. If a variable
|
| 236 | // matches a single path segment, its template may be omitted, e.g. `{var}`
|
| 237 | // is equivalent to `{var=*}`.
|
| 238 | //
|
| 239 | // The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
|
| 240 | // contains any reserved character, such characters should be percent-encoded
|
| 241 | // before the matching.
|
| 242 | //
|
| 243 | // If a variable contains exactly one path segment, such as `"{var}"` or
|
| 244 | // `"{var=*}"`, when such a variable is expanded into a URL path on the client
|
| 245 | // side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
|
| 246 | // server side does the reverse decoding. Such variables show up in the
|
| 247 | // [Discovery Document](https://developers.google.com/discovery/v1/reference/apis)
|
| 248 | // as `{var}`.
|
| 249 | //
|
| 250 | // If a variable contains multiple path segments, such as `"{var=foo/*}"`
|
| 251 | // or `"{var=**}"`, when such a variable is expanded into a URL path on the
|
| 252 | // client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
|
| 253 | // The server side does the reverse decoding, except "%2F" and "%2f" are left
|
| 254 | // unchanged. Such variables show up in the
|
| 255 | // [Discovery Document](https://developers.google.com/discovery/v1/reference/apis)
|
| 256 | // as `{+var}`.
|
| 257 | //
|
| 258 | // ## Using gRPC API Service Configuration
|
| 259 | //
|
| 260 | // gRPC API Service Configuration (service config) is a configuration language
|
| 261 | // for configuring a gRPC service to become a user-facing product. The
|
| 262 | // service config is simply the YAML representation of the `google.api.Service`
|
| 263 | // proto message.
|
| 264 | //
|
| 265 | // As an alternative to annotating your proto file, you can configure gRPC
|
| 266 | // transcoding in your service config YAML files. You do this by specifying a
|
| 267 | // `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
|
| 268 | // effect as the proto annotation. This can be particularly useful if you
|
| 269 | // have a proto that is reused in multiple services. Note that any transcoding
|
| 270 | // specified in the service config will override any matching transcoding
|
| 271 | // configuration in the proto.
|
| 272 | //
|
| 273 | // Example:
|
| 274 | //
|
| 275 | // http:
|
| 276 | // rules:
|
| 277 | // # Selects a gRPC method and applies HttpRule to it.
|
| 278 | // - selector: example.v1.Messaging.GetMessage
|
| 279 | // get: /v1/messages/{message_id}/{sub.subfield}
|
| 280 | //
|
| 281 | // ## Special notes
|
| 282 | //
|
| 283 | // When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
|
| 284 | // proto to JSON conversion must follow the [proto3
|
| 285 | // specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
|
| 286 | //
|
| 287 | // While the single segment variable follows the semantics of
|
| 288 | // [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
|
| 289 | // Expansion, the multi segment variable **does not** follow RFC 6570 Section
|
| 290 | // 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
|
| 291 | // does not expand special characters like `?` and `#`, which would lead
|
| 292 | // to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
|
| 293 | // for multi segment variables.
|
| 294 | //
|
| 295 | // The path variables **must not** refer to any repeated or mapped field,
|
| 296 | // because client libraries are not capable of handling such variable expansion.
|
| 297 | //
|
| 298 | // The path variables **must not** capture the leading "/" character. The reason
|
| 299 | // is that the most common use case "{var}" does not capture the leading "/"
|
| 300 | // character. For consistency, all path variables must share the same behavior.
|
| 301 | //
|
| 302 | // Repeated message fields must not be mapped to URL query parameters, because
|
| 303 | // no client library can support such complicated mapping.
|
| 304 | //
|
| 305 | // If an API needs to use a JSON array for request or response body, it can map
|
| 306 | // the request or response body to a repeated field. However, some gRPC
|
| 307 | // Transcoding implementations may not support this feature.
|
| 308 | message HttpRule {
|
| 309 | // Selects a method to which this rule applies.
|
| 310 | //
|
| 311 | // Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
|
| 312 | string selector = 1;
|
| 313 |
|
| 314 | // Determines the URL pattern is matched by this rules. This pattern can be
|
| 315 | // used with any of the {get|put|post|delete|patch} methods. A custom method
|
| 316 | // can be defined using the 'custom' field.
|
| 317 | oneof pattern {
|
| 318 | // Maps to HTTP GET. Used for listing and getting information about
|
| 319 | // resources.
|
| 320 | string get = 2;
|
| 321 |
|
| 322 | // Maps to HTTP PUT. Used for replacing a resource.
|
| 323 | string put = 3;
|
| 324 |
|
| 325 | // Maps to HTTP POST. Used for creating a resource or performing an action.
|
| 326 | string post = 4;
|
| 327 |
|
| 328 | // Maps to HTTP DELETE. Used for deleting a resource.
|
| 329 | string delete = 5;
|
| 330 |
|
| 331 | // Maps to HTTP PATCH. Used for updating a resource.
|
| 332 | string patch = 6;
|
| 333 |
|
| 334 | // The custom pattern is used for specifying an HTTP method that is not
|
| 335 | // included in the `pattern` field, such as HEAD, or "*" to leave the
|
| 336 | // HTTP method unspecified for this rule. The wild-card rule is useful
|
| 337 | // for services that provide content to Web (HTML) clients.
|
| 338 | CustomHttpPattern custom = 8;
|
| 339 | }
|
| 340 |
|
| 341 | // The name of the request field whose value is mapped to the HTTP request
|
| 342 | // body, or `*` for mapping all request fields not captured by the path
|
| 343 | // pattern to the HTTP body, or omitted for not having any HTTP request body.
|
| 344 | //
|
| 345 | // NOTE: the referred field must be present at the top-level of the request
|
| 346 | // message type.
|
| 347 | string body = 7;
|
| 348 |
|
| 349 | // Optional. The name of the response field whose value is mapped to the HTTP
|
| 350 | // response body. When omitted, the entire response message will be used
|
| 351 | // as the HTTP response body.
|
| 352 | //
|
| 353 | // NOTE: The referred field must be present at the top-level of the response
|
| 354 | // message type.
|
| 355 | string response_body = 12;
|
| 356 |
|
| 357 | // Additional HTTP bindings for the selector. Nested bindings must
|
| 358 | // not contain an `additional_bindings` field themselves (that is,
|
| 359 | // the nesting may only be one level deep).
|
| 360 | repeated HttpRule additional_bindings = 11;
|
| 361 | }
|
| 362 |
|
| 363 | // A custom pattern is used for defining custom HTTP verb.
|
| 364 | message CustomHttpPattern {
|
| 365 | // The name of this custom HTTP verb.
|
| 366 | string kind = 1;
|
| 367 |
|
| 368 | // The path matched by this custom verb.
|
| 369 | string path = 2;
|
| 370 | }
|