pnd.proto

syntax = "proto3";

package gosdn.pnd;

import "google/protobuf/descriptor.proto";
import "github.com/openconfig/gnmi/proto/gnmi/gnmi.proto";

option go_package = "proto/gosdn/pnd";

service pnd {
  rpc Get(GetRequest) returns (GetResponse);
  rpc Set(SetRequest) returns (SetResponse);
}

message GetRequest {
  int64 timestamp = 1;          // Timestamp in nanoseconds since Epoch.
  enum get_type {
    PND = 0;
    OND = 1;
    ONDS = 2;
    SBI = 3;
    SBIS = 4;
    Changes = 5;
  }
  get_type type = 2;
  string id = 3;
}

message GetResponse {
  int64 timestamp = 1;          // Timestamp in nanoseconds since Epoch.
  oneof payload {
    PrincipalNetworkDomain pnd = 2;
    OrchestratedNetworkingDevice ond = 3;
    OrchestratedNetworkingDevices onds = 4;
    SouthboundInterface sbi = 5;
    SouthboundInterfaces sbis = 6;
    Changes changes = 7;
  }

}

message PrincipalNetworkDomain {
  string id = 1;
  string name = 2;
  string description = 3;
  OrchestratedNetworkingDevices onds = 4;
  SouthboundInterfaces sbis = 5;
  Changes changes = 6;
}

message SouthboundInterface {
  string id = 1;
  string schema = 2;
}

message OrchestratedNetworkingDevice {
  string id = 1;
  string name = 2;
  gnmi.Notification device = 3;
}

message SouthboundInterfaces {
  map<string, SouthboundInterface> sbis = 1;
}

message OrchestratedNetworkingDevices {
  map<string, OrchestratedNetworkingDevice> sbis = 1;
}

message Change {
  string id = 1;
  int64 age = 2;
  enum State {
    PENDING = 0;
    COMMITTED = 1;
    CONFIRMED = 2;
  }
  State state = 3;
}

message Changes {
  map<string, Change> sbis = 1;
}

message SetRequest {
  int64 timestamp = 1;          // Timestamp in nanoseconds since Epoch.
  oneof request {
    ChangeRequest change = 2;
    OrchestratedNetworkingDevice ond = 3;
    SouthboundInterface sbi = 4;
  }
}

message SetResponse{
  int64 timestamp = 1;          // Timestamp in nanoseconds since Epoch.
  enum status {
    OK = 0;
    ERROR = 1;
  }
}

message ChangeRequest {
  enum Operation {
    CREATE = 0;
    COMMIT = 1;
    CONFIRM = 2;
  }
  enum ApiOperation {
    UPDATE = 0;
    REPLACE = 1;
    DELETE = 2;
  }
  string id = 1;
  string path = 2;
  string value = 3;
  ApiOperation apiOp = 4;
  Operation op = 5;
}