71 lines
2.4 KiB
Protocol Buffer
71 lines
2.4 KiB
Protocol Buffer
|
// Copyright 2021 Unistack LLC
|
||
|
|
//
|
||
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
// you may not use this file except in compliance with the License.
|
||
|
|
// You may obtain a copy of the License at
|
||
|
|
//
|
||
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
//
|
||
|
|
// Unless required by applicable law or agreed to in writing, software
|
||
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
// See the License for the specific language governing permissions and
|
||
|
|
// limitations under the License.
|
||
|
|
|
||
|
|
syntax = "proto3";
|
||
|
|
|
||
|
|
package micro.proto;
|
||
|
|
|
||
|
|
option cc_enable_arenas = true;
|
||
|
|
option go_package = "github.com/unistack-org/micro-proto/micro;micro";
|
||
|
|
option java_multiple_files = true;
|
||
|
|
option java_outer_classname = "MicroProto";
|
||
|
|
option java_package = "micro.proto";
|
||
|
|
option objc_class_prefix = "MPROTO";
|
||
|
|
|
||
|
|
// Message that represents an arbitrary byes. It should only be used for
|
||
|
|
// payload formats that can't be represented as any other messages like raw binary.
|
||
|
|
//
|
||
|
|
//
|
||
|
|
// This message can be used both in streaming and non-streaming API methods in
|
||
|
|
// the request as well as the response.
|
||
|
|
//
|
||
|
|
// It can be used as a top-level request field, which is convenient if one
|
||
|
|
// wants to extract parameters from either the URL or HTTP template into the
|
||
|
|
// request fields and also want access to the raw HTTP body.
|
||
|
|
//
|
||
|
|
// Example:
|
||
|
|
//
|
||
|
|
// message GetResourceRequest {
|
||
|
|
// // A unique request id.
|
||
|
|
// string request_id = 1;
|
||
|
|
//
|
||
|
|
// // The raw HTTP body is bound to this field.
|
||
|
|
// micro.proto.Frame http_body = 2;
|
||
|
|
// }
|
||
|
|
//
|
||
|
|
// service ResourceService {
|
||
|
|
// rpc GetResource(GetResourceRequest) returns (micro.proto.Frame);
|
||
|
|
// rpc UpdateResource(micro.proto.Frame) returns
|
||
|
|
// (google.protobuf.Empty);
|
||
|
|
// }
|
||
|
|
//
|
||
|
|
// Example with streaming methods:
|
||
|
|
//
|
||
|
|
// service CaldavService {
|
||
|
|
// rpc GetCalendar(stream micro.proto.Frame)
|
||
|
|
// returns (stream micro.proto.Frame);
|
||
|
|
// rpc UpdateCalendar(stream micro.proto.Frame)
|
||
|
|
// returns (stream micro.proto.Frame);
|
||
|
|
// }
|
||
|
|
//
|
||
|
|
// Use of this type only changes how the request and response bodies are
|
||
|
|
// handled, all other features will continue to work unchanged.
|
||
|
|
message Frame {
|
||
|
|
// Application specific response metadata. Must be set in the first response
|
||
|
|
// for streaming APIs.
|
||
|
|
map<string,string> headers = 1;
|
||
|
|
// The HTTP request/response body as raw binary.
|
||
|
|
bytes data = 2;
|
||
|
|
}
|