Files
spark/src/lib/api/services/AlgoService.proto
T

97 lines
2.6 KiB
Protocol Buffer

syntax="proto3";
package bts.api.orderman;
option csharp_namespace="bts.api.orderman";
import "lib/api/apioptions.proto";
import "lib/api/apicore.proto";
import "lib/api/services/OrderService.proto";
import "google/protobuf/timestamp.proto";
message PersistenceRecordCommon{
bool is_active = 10;
uint32 creator_user_id = 20;
google.protobuf.Timestamp creation_time = 30;
google.protobuf.Timestamp last_edit_time = 40;
google.protobuf.Timestamp deletion_time = 50;
}
message CompositeAlgoDefinition {
string name = 10;
CustomOrderDefinition algo = 20;
// re-naming map in the future
}
message CompositeAlgoRecord {
uint32 key = 10 [(bts.api.key)=true];
PersistenceRecordCommon common = 20;
CompositeAlgoDefinition algo_definition = 30;
}
message AlgoTemplate{
string name = 10;
// this is where the data is
oneof AlgoParams {
CompositeAlgoDefinition composite_algo_params = 20;
CustomOrderDefinition system_algo_params = 30;
}
bool is_default = 40;
}
message AlgoTemplateRecord{
uint32 key = 10 [(bts.api.key)=true];
PersistenceRecordCommon common = 20;
AlgoTemplate algo_template = 30;
}
///////////////////////////////////////////////////////////
// API ////////////////////////////////////////////////////
message CompositeAlgoCreateRequest{
uint32 user_id = 10;
CompositeAlgoDefinition new_algo = 20;
}
message CompositeAlgoCreateResult{
bool success = 10;
string err_msg = 20;
CompositeAlgoRecord record = 30;
}
message TemplateCreateRequest{
uint32 user_id = 10;
AlgoTemplate new_template = 20;
}
message TemplateCreateResult{
bool success = 10;
string err_msg = 20;
AlgoTemplateRecord record = 30;
}
message TemplateUpdateRequest{
uint32 key = 10;
AlgoTemplate updated_template = 20;
}
message AlgoServiceRemoveRequest{
uint32 key = 10;
}
message AlgoServiceReply{
bool success = 10;
bool err_msg = 20;
}
service AlgoService {
option (bts.api.service_description)="Provides an interface to manage composite algos and templates";
// service calls
rpc create_composite_algo(CompositeAlgoCreateRequest) returns (CompositeAlgoCreateResult);
rpc create_template(TemplateCreateRequest) returns (TemplateCreateResult);
rpc update_template(TemplateUpdateRequest) returns (AlgoServiceReply);
rpc remove_template(AlgoServiceRemoveRequest) returns (AlgoServiceReply);
// streams
rpc algos(bts.api.VoidMessage) returns (stream CompositeAlgoRecord);
rpc algo_templates(bts.api.VoidMessage) returns (stream AlgoTemplateRecord);
}