package yorkie.v1

NOTE(hackerwins): Select Operation is not used in the current version. In the previous version, it was used to represent selection of Text. However, it has been replaced by Presence now. It is retained for backward compatibility purposes.

Used in: Operation

optional TimeTicket parent_created_at = 1
optional TextNodePos from = 2
optional TextNodePos to = 3
optional TimeTicket executed_at = 4

Used in: Operation

optional TimeTicket parent_created_at = 1
string key = 2
optional JSONElementSimple value = 3
optional TimeTicket executed_at = 4

Used in: Operation

optional TimeTicket parent_created_at = 1
optional TextNodePos from = 2
optional TextNodePos to = 3
map<string, string> attributes = 4
optional TimeTicket executed_at = 5
map<string, TimeTicket> created_at_map_by_actor = 6
deprecated

Used in: Operation

optional TimeTicket parent_created_at = 1
optional TreePos from = 2
optional TreePos to = 3
map<string, TimeTicket> created_at_map_by_actor = 4
deprecated
repeated TreeNodes contents = 5
int32 split_level = 7
optional TimeTicket executed_at = 6

Used in: Operation

optional TimeTicket parent_created_at = 1
optional TreePos from = 2
optional TreePos to = 3
map<string, string> attributes = 4
optional TimeTicket executed_at = 5
repeated string attributes_to_remove = 6
map<string, TimeTicket> created_at_map_by_actor = 7
deprecated

Used in: PresenceChange, Snapshot

map<string, string> data = 1

Used in: Change

PresenceChange.ChangeType type = 1
optional Presence presence = 2

Used in: PresenceChange

CHANGE_TYPE_UNSPECIFIED = 0
CHANGE_TYPE_PUT = 1
CHANGE_TYPE_DELETE = 2
CHANGE_TYPE_CLEAR = 3

Used in: ClusterServiceDetachDocumentRequest, CreateProjectResponse, GetProjectResponse, ListProjectsResponse, UpdateProjectResponse

string id = 1
string name = 2
string public_key = 3
string secret_key = 4
string auth_webhook_url = 5
repeated string auth_webhook_methods = 6
string event_webhook_url = 7
repeated string event_webhook_events = 8
string client_deactivate_threshold = 9
int32 max_subscribers_per_document = 10
int32 max_attachments_per_document = 11
repeated string allowed_origins = 14
optional google.protobuf.Timestamp created_at = 12
optional google.protobuf.Timestamp updated_at = 13

Used in: JSONElement.JSONArray

optional RGANode next = 1
optional JSONElement element = 2

Used in: JSONElement.JSONObject

string key = 1
optional JSONElement element = 2

/////////////////////////////////////// Messages for Snapshot // ///////////////////////////////////////

optional JSONElement root = 1
map<string, Presence> presences = 2

Used in: JSONElement.Text

optional TextNodeID id = 1
string value = 2
optional TimeTicket removed_at = 3
optional TextNodeID ins_prev_id = 4
map<string, NodeAttr> attributes = 5

Used in: TextNode

optional TimeTicket created_at = 1
int32 offset = 2

Used in: Operation.Edit, Operation.Select, Operation.Style

optional TimeTicket created_at = 1
int32 offset = 2
int32 relative_offset = 3

Used in: ChangePack, JSONElement.Counter, JSONElement.JSONArray, JSONElement.JSONObject, JSONElement.Primitive, JSONElement.Text, JSONElement.Tree, JSONElementSimple, NodeAttr, Operation.Add, Operation.ArraySet, Operation.Edit, Operation.Increase, Operation.Move, Operation.Remove, Operation.Select, Operation.Set, Operation.Style, Operation.TreeEdit, Operation.TreeStyle, TextNode, TextNodeID, TextNodePos, TreeNode, TreeNodeID

int64 lamport = 1
uint32 delimiter = 2
bytes actor_id = 3

Used in: JSONElement.Tree, TreeNodes

optional TreeNodeID id = 1
string type = 2
string value = 3
optional TimeTicket removed_at = 4
optional TreeNodeID ins_prev_id = 5
optional TreeNodeID ins_next_id = 6
int32 depth = 7
map<string, NodeAttr> attributes = 8

Used in: TreeNode, TreePos

optional TimeTicket created_at = 1
int32 offset = 2

Used in: Operation.TreeEdit

repeated TreeNode content = 1

Used in: Operation.TreeEdit, Operation.TreeStyle

optional TreeNodeID parent_id = 1
optional TreeNodeID left_sibling_id = 2

Used in: UpdateProjectRequest

optional google.protobuf.StringValue name = 1
optional google.protobuf.StringValue auth_webhook_url = 2
optional UpdatableProjectFields.AuthWebhookMethods auth_webhook_methods = 3
optional google.protobuf.StringValue event_webhook_url = 4
optional UpdatableProjectFields.EventWebhookEvents event_webhook_events = 5
optional google.protobuf.StringValue client_deactivate_threshold = 6
optional google.protobuf.Int32Value max_subscribers_per_document = 7
optional google.protobuf.Int32Value max_attachments_per_document = 8
optional UpdatableProjectFields.AllowedOrigins allowed_origins = 9

Used in: UpdatableProjectFields

repeated string origins = 1

Used in: UpdatableProjectFields

repeated string methods = 1

Used in: UpdatableProjectFields

repeated string events = 1

Used in: SignUpResponse

string id = 1
string auth_provider = 2
string username = 3
optional google.protobuf.Timestamp created_at = 4

Used in: JSONElement.Counter, JSONElement.Primitive, JSONElementSimple

VALUE_TYPE_NULL = 0
VALUE_TYPE_BOOLEAN = 1
VALUE_TYPE_INTEGER = 2
VALUE_TYPE_LONG = 3
VALUE_TYPE_DOUBLE = 4
VALUE_TYPE_STRING = 5
VALUE_TYPE_BYTES = 6
VALUE_TYPE_DATE = 7
VALUE_TYPE_JSON_OBJECT = 8
VALUE_TYPE_JSON_ARRAY = 9
VALUE_TYPE_TEXT = 10
VALUE_TYPE_INTEGER_CNT = 11
VALUE_TYPE_LONG_CNT = 12
VALUE_TYPE_TREE = 13

Used in: ChangeID, ChangePack, GetSnapshotMetaResponse

map<string, int64> vector = 1

Used in: WatchDocumentResponse

repeated string client_ids = 1

package yorkie.v1

service AdminService

rpc SignUp (SignUpRequest, SignUpResponse)

message SignUpRequest

string username = 1

string password = 2

message SignUpResponse

optional User user = 1

rpc LogIn (LogInRequest, LogInResponse)

message LogInRequest

string username = 1

string password = 2

message LogInResponse

string token = 1

rpc DeleteAccount (DeleteAccountRequest, DeleteAccountResponse)

message DeleteAccountRequest

string username = 1

string password = 2

message DeleteAccountResponse

rpc ChangePassword (ChangePasswordRequest, ChangePasswordResponse)

message ChangePasswordRequest

string username = 1

string current_password = 2

string new_password = 3

message ChangePasswordResponse

rpc CreateProject (CreateProjectRequest, CreateProjectResponse)

message CreateProjectRequest

string name = 1

message CreateProjectResponse

optional Project project = 1

rpc ListProjects (ListProjectsRequest, ListProjectsResponse)

message ListProjectsRequest

message ListProjectsResponse

repeated Project projects = 1

rpc GetProject (GetProjectRequest, GetProjectResponse)

message GetProjectRequest

string name = 1

message GetProjectResponse

optional Project project = 1

rpc UpdateProject (UpdateProjectRequest, UpdateProjectResponse)

message UpdateProjectRequest

string id = 1

optional UpdatableProjectFields fields = 2

message UpdateProjectResponse

optional Project project = 1

rpc GetProjectStats (GetProjectStatsRequest, GetProjectStatsResponse)

message GetProjectStatsRequest

string project_name = 1

GetProjectStatsRequest.DateRange date_range = 2

message GetProjectStatsResponse

int32 active_users_count = 1

repeated MetricPoint active_users = 2

int64 documents_count = 3

int64 clients_count = 4

rpc ListDocuments (ListDocumentsRequest, ListDocumentsResponse)

message ListDocumentsRequest

string project_name = 1

string previous_id = 2

int32 page_size = 3

bool is_forward = 4

bool include_snapshot = 5

message ListDocumentsResponse

repeated DocumentSummary documents = 1

rpc GetDocument (GetDocumentRequest, GetDocumentResponse)

message GetDocumentRequest

string project_name = 1

string document_key = 2

message GetDocumentResponse

optional DocumentSummary document = 1

rpc GetDocuments (GetDocumentsRequest, GetDocumentsResponse)

message GetDocumentsRequest

string project_name = 1

repeated string document_keys = 2

bool include_snapshot = 3

message GetDocumentsResponse

repeated DocumentSummary documents = 1

rpc RemoveDocumentByAdmin (RemoveDocumentByAdminRequest, RemoveDocumentByAdminResponse)

message RemoveDocumentByAdminRequest

string project_name = 1

string document_key = 2