Skip to content
Snippets Groups Projects
Verified Commit 69733f6d authored by Timm Fitschen's avatar Timm Fitschen
Browse files

Add comments to acm proto

parent 0db2cffa
No related branches found
No related tags found
2 merge requests!8Release 0.2,!7F acm
Pipeline #15900 passed
......@@ -106,7 +106,9 @@ message User {
// Indicates whether the user is active. Only active users can sign in and
// interact with the CaosDB Server.
string active = 1;
// Realm of this user. The realm is the authority which can authenticate this user, e.g. 'PAM' when the user is a (POSIX) user from the server's host, or 'CaosDB' when CaosDB Server itself can authenticate the user.
// Realm of this user. The realm is the authority which can authenticate this
// user, e.g. 'PAM' when the user is a (POSIX) user from the server's host, or
// 'CaosDB' when CaosDB Server itself can authenticate the user.
string realm = 2;
// Name of this user.
string name = 3;
......@@ -128,7 +130,8 @@ message ListUsersRequest {
message ListUsersResponse {
// Actual paging setting of the response.
PagingResponse paging = 1;
// A subset (when paging is used) or the complete set (otherwise) of known users.
// A subset (when paging is used) or the complete set (otherwise) of known
// users.
repeated User users = 2;
}
......@@ -160,29 +163,37 @@ service AccessControlManagementService {
rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) {};
// Retrieve a single user
rpc RetrieveSingleUser(RetrieveSingleUserRequest) returns (RetrieveSingleUserResponse) {};
rpc RetrieveSingleUser(RetrieveSingleUserRequest)
returns (RetrieveSingleUserResponse) {};
// Create a single new user
rpc CreateSingleUser(CreateSingleUserRequest) returns (CreateSingleUserResponse) {};
rpc CreateSingleUser(CreateSingleUserRequest)
returns (CreateSingleUserResponse) {};
// Update a single user
rpc UpdateSingleUser(UpdateSingleUserRequest) returns (UpdateSingleUserResponse) {};
rpc UpdateSingleUser(UpdateSingleUserRequest)
returns (UpdateSingleUserResponse) {};
// Delete a single user
rpc DeleteSingleUser(DeleteSingleUserRequest) returns (DeleteSingleUserResponse) {};
rpc DeleteSingleUser(DeleteSingleUserRequest)
returns (DeleteSingleUserResponse) {};
// Request the list of roles.
rpc ListRoles(ListRolesRequest) returns (ListRolesResponse) {};
// Retrieve a single role
rpc RetrieveSingleRole(RetrieveSingleRoleRequest) returns (RetrieveSingleRoleResponse) {};
rpc RetrieveSingleRole(RetrieveSingleRoleRequest)
returns (RetrieveSingleRoleResponse) {};
// Create a single new role
rpc CreateSingleRole(CreateSingleRoleRequest) returns (CreateSingleRoleResponse) {};
rpc CreateSingleRole(CreateSingleRoleRequest)
returns (CreateSingleRoleResponse) {};
// Update a single role
rpc UpdateSingleRole(UpdateSingleRoleRequest) returns (UpdateSingleRoleResponse) {};
rpc UpdateSingleRole(UpdateSingleRoleRequest)
returns (UpdateSingleRoleResponse) {};
// Delete a single role
rpc DeleteSingleRole(DeleteSingleRoleRequest) returns (DeleteSingleRoleResponse) {};
rpc DeleteSingleRole(DeleteSingleRoleRequest)
returns (DeleteSingleRoleResponse) {};
}
......@@ -25,7 +25,6 @@ option java_package = "org.caosdb.api.info.v1";
package caosdb.info.v1;
/////////////////////////////// SERVER VERSION
// The version of an agent (following SemVer 2.0.0)
......@@ -54,14 +53,17 @@ message GetVersionInfoResponse {
////////////////////////// SESSION
// Request message for the GetSessionInfo RPC
message GetSessionInfoRequest {
}
message GetSessionInfoRequest {}
// Response message for the GetSessionInfo RPC
message GetSessionInfoResponse {
// The realm of the user who owns this session
string realm = 1;
// The name of the user who owns this session
string username = 2;
// The roles of the user who owns this session
repeated string roles = 3;
// Seconds until this sessions expires (approximately).
int64 expires = 4;
}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment