memos/proto/api/v1/workspace_service.proto

31 lines
849 B
Protocol Buffer
Raw Normal View History

2024-01-28 07:35:42 +08:00
syntax = "proto3";
2024-04-28 00:44:29 +08:00
package memos.api.v1;
2024-01-28 07:35:42 +08:00
import "google/api/annotations.proto";
2024-04-28 00:44:29 +08:00
option go_package = "gen/api/v1";
2024-01-28 07:35:42 +08:00
service WorkspaceService {
2024-02-01 21:26:09 +08:00
// GetWorkspaceProfile returns the workspace profile.
2024-04-27 22:02:15 +08:00
rpc GetWorkspaceProfile(GetWorkspaceProfileRequest) returns (WorkspaceProfile) {
2024-04-28 00:44:29 +08:00
option (google.api.http) = {get: "/api/v1/workspace/profile"};
2024-01-28 07:35:42 +08:00
}
}
message WorkspaceProfile {
2024-04-16 21:15:17 +08:00
// The name of instance owner.
2024-03-21 21:39:34 +08:00
// Format: "users/{id}"
string owner = 1;
// version is the current version of instance
2024-03-21 21:39:34 +08:00
string version = 2;
// mode is the instance mode (e.g. "prod", "dev" or "demo").
2024-03-21 21:39:34 +08:00
string mode = 3;
// public is a flag that the instance is open for other users.
bool public = 4;
2024-07-27 19:24:37 +08:00
// password_auth is a flag whether the instance allows password authentication.
bool password_auth = 5;
2024-01-28 07:35:42 +08:00
}
message GetWorkspaceProfileRequest {}