user.proto

syntax = "proto3";

package api;

import "google/protobuf/timestamp.proto";

message User {
    // @inject_tag: bson:"_id"
    string ID = 1;
    // @inject_tag: bson:"username"
    string Username = 2;
    // @inject_tag: bson:"groups"
    repeated string Groups = 3;
    // @inject_tag: bson:"roleid"
    string RoleID = 4;
    // @inject_tag: bson:"createdby"
    string CreatedBy = 5;
    // @inject_tag: bson:"createdat"
    google.protobuf.Timestamp CreatedAt = 6;
    // @inject_tag: bson:"modifiedby"
    string ModifiedBy = 7;
    // @inject_tag: bson:"modifiedat"
    google.protobuf.Timestamp ModifiedAt = 8;
}

message UserListReq {
    // do not filter
}

message UserListRes {
    // return a collection of users
    repeated User Users = 1;
}

message UserCreateReq {
    // create a user
    string Username = 1;
    repeated string Groups = 2;
    string RoleID = 3;
    string CreatedBy = 4;
}

message UserCreateRes {
    // reutrn an id
    string ID = 1;
}

message UserReadReq {
    // read a user by id
    string ID = 1;
}

message UserReadRes {
    // return a user
    User User = 1;
}

message UserReadByUsernameReq {
    // read a user by id
    string Username = 1;
}

message UserReadByUsernameRes {
    // return a user
    User User = 1;
}

message UserUpdateReq {
    // update a user by id
    string ID = 1;
    repeated string Groups = 2;
    string RoleID = 3;
    string ModifiedBy = 4;
}

message UserUpdateRes {
    // return number of users updated
    // should equal 1 on success
    int64 Updated = 1;
}

message UserDeleteReq {
    // delete a user by id
    string ID = 1;
}

message UserDeleteRes {
    // return number of users deleted
    // should equal 1 on success
    int64 Deleted = 1;
}

service UserService {
    rpc List(UserListReq) returns (UserListRes);
    rpc Create(UserCreateReq) returns (UserCreateRes);
    rpc Read(UserReadReq) returns (UserReadRes);
    rpc ReadByUsername(UserReadByUsernameReq) returns (UserReadByUsernameRes);
    rpc Update(UserUpdateReq) returns (UserUpdateRes);
    rpc Delete(UserDeleteReq) returns (UserDeleteRes);
}