Release 1.2.3
[ric-app/ts.git] / ext / protobuf / api.proto
1 syntax = "proto3";
2 package api;
3
4 enum RICControlCellTypeEnum {
5
6     RIC_CONTROL_CELL_UNKWON = 0;
7     RIC_CONTROL_NR_CELL = 1;            // Indicates RIC Controls should be set for NR CELL
8     RIC_CONTROL_EUTRAN_CELL = 2;    // Indicates RIC Controls should be set for E_UTRAN CELL
9 }
10
11 enum RICControlAckEnum {
12
13     RIC_CONTROL_ACK_UNKWON = 0;
14     RIC_CONTROL_NO_ACK = 1; // Optional RIC Control Acknowledgement is not required
15     RIC_CONTROL_ACK = 2;    // Optional RIC Control Acknowledgement is required
16     RIC_CONTROL_NACK = 3;   // Optional RIC Control Acknowledgement is only required to report failure
17 }
18
19 message RICE2APHeader  {
20         int64          RanFuncId = 1;
21         int64          RICRequestorID = 2;
22 }
23
24 message RICControlHeader {
25         int64           ControlStyle = 1;
26         int64           ControlActionId = 2;
27         string          UEID = 3;
28 }
29
30
31 message RICControlMessage {
32         RICControlCellTypeEnum    RICControlCellTypeVal = 1;
33         string                    TargetCellID = 2;
34
35 }
36
37 //RicControl GRPC Req
38 message RicControlGrpcReq {
39         string              e2NodeID = 1;
40         string              plmnID = 2;
41         string              ranName = 3;
42         RICE2APHeader       RICE2APHeaderData = 4;
43         RICControlHeader    RICControlHeaderData = 5;
44         RICControlMessage   RICControlMessageData = 6;
45         RICControlAckEnum   RICControlAckReqVal = 7; //Currently this Parameter is not Encoded as Part of RIC Control message
46 }
47
48 //RicControlGrpc Rsp
49 message RicControlGrpcRsp {
50     int32   rspCode = 1;       //Set rspCode to 0. Acknowledging the receipt of GRPC request
51     string  description = 2;   //Set despcription.
52 }
53
54 // Services to send gRPC
55 service MsgComm {
56     //gRPC call to Send RICControlReqServiceGrpc
57     rpc SendRICControlReqServiceGrpc(RicControlGrpcReq) returns (RicControlGrpcRsp);
58 }
59
60