package yorkie.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Yorkie is a service that provides an API for SDKs.

• rpc ActivateClient (ActivateClientRequest, ActivateClientResponse)

  yorkie.proto:29

  message ActivateClientRequest

  yorkie.proto:50

  • string client_key = 1

  • map<string, string> metadata = 2

  message ActivateClientResponse

  yorkie.proto:55

  • string client_id = 1

• rpc AttachChannel (AttachChannelRequest, AttachChannelResponse)

  yorkie.proto:43

  message AttachChannelRequest

  yorkie.proto:220

  • string client_id = 1

  • string channel_key = 2

  message AttachChannelResponse

  yorkie.proto:225

  • string session_id = 1

  • int64 session_count = 2

• rpc AttachDocument (AttachDocumentRequest, AttachDocumentResponse)

  yorkie.proto:32

  message AttachDocumentRequest

  yorkie.proto:67

  • string client_id = 1

  • optional ChangePack change_pack = 2

  • string schema_key = 3

  message AttachDocumentResponse

  yorkie.proto:73

  • string document_id = 1

  • optional ChangePack change_pack = 2

  • int32 max_size_per_document = 3

  • repeated Rule schema_rules = 4

• rpc Broadcast (BroadcastRequest, BroadcastResponse)

  yorkie.proto:47

  message BroadcastRequest

  yorkie.proto:262

  • string client_id = 1

  • string channel_key = 2

  • string topic = 3

  • bytes payload = 4

  message BroadcastResponse

  yorkie.proto:269

  (message has no fields)

• rpc CreateRevision (CreateRevisionRequest, CreateRevisionResponse)

  yorkie.proto:38

  message CreateRevisionRequest

  yorkie.proto:178

  • string client_id = 1

  • string document_id = 2

  • string label = 3

  • string description = 4

  message CreateRevisionResponse

  yorkie.proto:185

  • optional RevisionSummary revision = 1

• rpc DeactivateClient (DeactivateClientRequest, DeactivateClientResponse)

  yorkie.proto:30

  message DeactivateClientRequest

  yorkie.proto:59

  • string client_id = 1

  • bool synchronous = 2

  message DeactivateClientResponse

  yorkie.proto:64

  (message has no fields)

• rpc DetachChannel (DetachChannelRequest, DetachChannelResponse)

  yorkie.proto:44

  message DetachChannelRequest

  yorkie.proto:230

  • string client_id = 1

  • string channel_key = 2

  • string session_id = 3

  message DetachChannelResponse

  yorkie.proto:236

  • int64 session_count = 1

• rpc DetachDocument (DetachDocumentRequest, DetachDocumentResponse)

  yorkie.proto:33

  message DetachDocumentRequest

  yorkie.proto:80

  • string client_id = 1

  • string document_id = 2

  • optional ChangePack change_pack = 3

  • bool remove_if_not_attached = 4

  message DetachDocumentResponse

  yorkie.proto:87

  • optional ChangePack change_pack = 2

• rpc GetRevision (GetRevisionRequest, GetRevisionResponse)

  yorkie.proto:39

  message GetRevisionRequest

  yorkie.proto:189

  • string client_id = 1

  • string document_id = 2

  • string revision_id = 3

  message GetRevisionResponse

  yorkie.proto:195

  • optional RevisionSummary revision = 1

• rpc ListRevisions (ListRevisionsRequest, ListRevisionsResponse)

  yorkie.proto:40

  message ListRevisionsRequest

  yorkie.proto:199

  • string client_id = 1

  • string document_id = 2

  • int32 page_size = 3

  • int32 offset = 4

  • bool is_forward = 5

  message ListRevisionsResponse

  yorkie.proto:207

  • repeated RevisionSummary revisions = 1

• rpc PeekChannel (PeekChannelRequest, PeekChannelResponse)

  yorkie.proto:46

  message PeekChannelRequest

  yorkie.proto:254

  PeekChannel reads the current session_count of a channel without creating a session on the server. Use this when a client only needs to display the count (e.g. "N people writing") without contributing to it and without receiving broadcasts. Caller polls on its own cadence.

  • string channel_key = 1

  message PeekChannelResponse

  yorkie.proto:258

  • int64 session_count = 1

• rpc PushPullChanges (PushPullChangesRequest, PushPullChangesResponse)

  yorkie.proto:35

  message PushPullChangesRequest

  yorkie.proto:167

  • string client_id = 1

  • string document_id = 2

  • optional ChangePack change_pack = 3

  • bool push_only = 4

  message PushPullChangesResponse

  yorkie.proto:174

  • optional ChangePack change_pack = 1

• rpc RefreshChannel (RefreshChannelRequest, RefreshChannelResponse)

  yorkie.proto:45

  message RefreshChannelRequest

  yorkie.proto:240

  • string client_id = 1

  • string channel_key = 2

  • string session_id = 3

  message RefreshChannelResponse

  yorkie.proto:246

  • int64 session_count = 1

• rpc RemoveDocument (RemoveDocumentRequest, RemoveDocumentResponse)

  yorkie.proto:34

  message RemoveDocumentRequest

  yorkie.proto:157

  • string client_id = 1

  • string document_id = 2

  • optional ChangePack change_pack = 3

  message RemoveDocumentResponse

  yorkie.proto:163

  • optional ChangePack change_pack = 1

• rpc RestoreRevision (RestoreRevisionRequest, RestoreRevisionResponse)

  yorkie.proto:41

  message RestoreRevisionRequest

  yorkie.proto:211

  • string client_id = 1

  • string document_id = 2

  • string revision_id = 4

  message RestoreRevisionResponse

  yorkie.proto:217

  (message has no fields)

• rpc Watch (WatchRequest, stream WatchResponse)

  yorkie.proto:36

  message WatchRequest

  yorkie.proto:91

  • string client_id = 1

  • repeated ResourceDescriptor resources = 2

  message WatchResponse

  yorkie.proto:111

  • oneof body

    • WatchInitialization initialization = 1

    • WatchEvent event = 2

Used in: ChangePack

• optional ChangeID id = 1

• string message = 2

• repeated Operation operations = 3

• optional PresenceChange presence_change = 4

Used in: Change

• uint32 client_seq = 1

• int64 server_seq = 2

• int64 lamport = 3

• bytes actor_id = 4

• optional VersionVector version_vector = 5

ChangePack is a message that contains all changes that occurred in a document. It is used to synchronize changes between clients and servers.

Used in: AttachDocumentRequest, AttachDocumentResponse, DetachDocumentRequest, DetachDocumentResponse, PushPullChangesRequest, PushPullChangesResponse, RemoveDocumentRequest, RemoveDocumentResponse

• string document_key = 1

• optional Checkpoint checkpoint = 2

• bytes snapshot = 3

• repeated Change changes = 4

• optional TimeTicket min_synced_ticket = 5

  deprecated

• bool is_removed = 6

• optional VersionVector version_vector = 7

Used in: ResourceDescriptor

• string channel_key = 1

Used in: ChannelWatchEvent

• ChannelEvent.Type type = 1

• string publisher = 2

• int64 session_count = 3

• int64 seq = 4

• string topic = 5

• bytes payload = 6

Used in: ChannelEvent

• TYPE_UNSPECIFIED = 0

• TYPE_PRESENCE = 1

• TYPE_BROADCAST = 2

Used in: ResourceInit

• string channel_key = 1

• int64 session_count = 2

• int64 seq = 3

• string key = 1

• int32 session_count = 2

Used in: WatchEvent

• string channel_key = 1

• optional ChannelEvent event = 2

Used in: ChangePack

• int64 server_seq = 1

• uint32 client_seq = 2

Used in: DocSize

• int32 data = 1

• int32 meta = 2

Used in: DocWatchEvent

• DocEventType type = 1

• string publisher = 2

• optional DocEventBody body = 3

Used in: DocEvent

• string topic = 1

• bytes payload = 2

Used in: DocEvent

• DOC_EVENT_TYPE_DOCUMENT_CHANGED = 0

• DOC_EVENT_TYPE_DOCUMENT_WATCHED = 1

• DOC_EVENT_TYPE_DOCUMENT_UNWATCHED = 2

• DOC_EVENT_TYPE_DOCUMENT_BROADCAST = 3

Used in: DocumentSummary

• optional DataSize live = 1

• optional DataSize gc = 2

Used in: WatchEvent

• string document_id = 1

• optional DocEvent event = 2

Used in: ResourceDescriptor

• string document_id = 1

Used in: ResourceInit

• string document_id = 1

• repeated string client_ids = 2

• string id = 1

• string key = 2

• string root = 3

• int32 attached_clients = 7

• optional DocSize document_size = 8

• string schema_key = 9

• map<string, Presence> presences = 10

• optional google.protobuf.Timestamp created_at = 4

• optional google.protobuf.Timestamp accessed_at = 5

• optional google.protobuf.Timestamp updated_at = 6

Used in: RGANode, RHTNode, Snapshot

• oneof body

  • JSONElement.JSONObject json_object = 1

  • JSONElement.JSONArray json_array = 2

  • JSONElement.Primitive primitive = 3

  • JSONElement.Text text = 5

  • JSONElement.Counter counter = 6

  • JSONElement.Tree tree = 7

Used in: JSONElement

• ValueType type = 1

• bytes value = 2

• optional TimeTicket created_at = 3

• optional TimeTicket moved_at = 4

• optional TimeTicket removed_at = 5

• bytes hll_registers = 7

Used in: JSONElement

• repeated RGANode nodes = 1

• optional TimeTicket created_at = 2

• optional TimeTicket moved_at = 3

• optional TimeTicket removed_at = 4

Used in: JSONElement

• repeated RHTNode nodes = 1

• optional TimeTicket created_at = 2

• optional TimeTicket moved_at = 3

• optional TimeTicket removed_at = 4

Used in: JSONElement

• ValueType type = 1

• bytes value = 2

• optional TimeTicket created_at = 3

• optional TimeTicket moved_at = 4

• optional TimeTicket removed_at = 5

Used in: JSONElement

• repeated TextNode nodes = 1

• optional TimeTicket created_at = 2

• optional TimeTicket moved_at = 3

• optional TimeTicket removed_at = 4

Used in: JSONElement

• repeated TreeNode nodes = 1

• optional TimeTicket created_at = 2

• optional TimeTicket moved_at = 3

• optional TimeTicket removed_at = 4

Used in: Operation.Add, Operation.ArraySet, Operation.Increase, Operation.Set

• optional TimeTicket created_at = 1

• optional TimeTicket moved_at = 2

• optional TimeTicket removed_at = 3

• ValueType type = 4

• bytes value = 5

• string id = 1

• string project_id = 2

• string user_id = 3

• string username = 4

• string role = 5

• optional google.protobuf.Timestamp invited_at = 6

• int64 timestamp = 1

• int32 value = 2

Used in: TextNode, TreeNode

• string value = 1

• optional TimeTicket updated_at = 2

• bool is_removed = 3

Used in: Change

• oneof body

  • Operation.Set set = 1

  • Operation.Add add = 2

  • Operation.Move move = 3

  • Operation.Remove remove = 4

  • Operation.Edit edit = 5

  • Operation.Style style = 7

  • Operation.Increase increase = 8

  • Operation.TreeEdit tree_edit = 9

  • Operation.TreeStyle tree_style = 10

  • Operation.ArraySet array_set = 11

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TimeTicket prev_created_at = 2

• optional JSONElementSimple value = 3

• optional TimeTicket executed_at = 4

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TimeTicket created_at = 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, TimeTicket> created_at_map_by_actor = 4

  deprecated

• string content = 5

• optional TimeTicket executed_at = 6

• map<string, string> attributes = 7

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional JSONElementSimple value = 2

• optional TimeTicket executed_at = 3

• string actor = 4

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TimeTicket prev_created_at = 2

• optional TimeTicket created_at = 3

• optional TimeTicket executed_at = 4

Used in: Operation

• optional TimeTicket parent_created_at = 1

• optional TimeTicket created_at = 2

• optional TimeTicket executed_at = 3

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

• repeated string attributes_to_remove = 7

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: DocumentSummary, 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

• 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

• uint64 auth_webhook_max_retries = 17

• string auth_webhook_min_wait_interval = 18

• string auth_webhook_max_wait_interval = 19

• string auth_webhook_request_timeout = 20

• string event_webhook_url = 7

• repeated string event_webhook_events = 8

• uint64 event_webhook_max_retries = 21

• string event_webhook_min_wait_interval = 22

• string event_webhook_max_wait_interval = 23

• string event_webhook_request_timeout = 24

• string client_deactivate_threshold = 9

• int64 snapshot_threshold = 25

• int64 snapshot_interval = 26

• int32 max_subscribers_per_document = 10

• int32 max_attachments_per_document = 11

• int32 max_size_per_document = 15

• bool remove_on_detach = 16

• bool auto_revision_enabled = 27

• 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

• optional TimeTicket position_created_at = 3

• optional TimeTicket position_moved_at = 4

• optional TimeTicket position_removed_at = 5

Used in: JSONElement.JSONObject

• string key = 1

• optional JSONElement element = 2

Used in: WatchRequest

• oneof resource

  • DocumentDescriptor document = 1

  • ChannelDescriptor channel = 2

Used in: WatchInitialization

• oneof init

  • DocumentInit document_init = 1

  • ChannelInit channel_init = 2

Used in: CreateRevisionResponse, GetRevisionResponse, ListRevisionsResponse

• string id = 1

• string label = 2

• string description = 3

• string snapshot = 4

• optional google.protobuf.Timestamp created_at = 5

Used in: AttachDocumentResponse, Schema

• string path = 1

• string type = 2

• repeated TreeNodeRule tree_nodes = 3

• string id = 1

• string name = 2

• int32 version = 3

• string body = 4

• repeated Rule rules = 5

• optional google.protobuf.Timestamp created_at = 6

/////////////////////////////////////// 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.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.Set, Operation.Style, Operation.TreeEdit, Operation.TreeStyle, RGANode, 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

• optional TreeNodeID merged_from = 9

  merged_from is set when this node was moved to a new parent by a concurrent merge. It points to the source parent's ID.

• optional TimeTicket merged_at = 10

  merged_at records the immutable ticket of the merge operation. Stored alongside merged_from because the source parent's removed_at may be overwritten by later LWW tombstones and thus cannot serve as the merge-time causal boundary for SplitElement.

Used in: TreeNode, TreePos

• optional TimeTicket created_at = 1

• int32 offset = 2

Used in: Rule

• string node_type = 1

• string content = 2

• string marks = 3

• string group = 4

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

• optional google.protobuf.StringValue name = 1

• optional google.protobuf.StringValue auth_webhook_url = 2

• optional UpdatableProjectFields.AuthWebhookMethods auth_webhook_methods = 3

• optional google.protobuf.UInt64Value auth_webhook_max_retries = 12

• optional google.protobuf.StringValue auth_webhook_min_wait_interval = 13

• optional google.protobuf.StringValue auth_webhook_max_wait_interval = 14

• optional google.protobuf.StringValue auth_webhook_request_timeout = 15

• optional google.protobuf.StringValue event_webhook_url = 4

• optional UpdatableProjectFields.EventWebhookEvents event_webhook_events = 5

• optional google.protobuf.UInt64Value event_webhook_max_retries = 16

• optional google.protobuf.StringValue event_webhook_min_wait_interval = 17

• optional google.protobuf.StringValue event_webhook_max_wait_interval = 18

• optional google.protobuf.StringValue event_webhook_request_timeout = 19

• optional google.protobuf.Int64Value snapshot_threshold = 20

• optional google.protobuf.Int64Value snapshot_interval = 21

• 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 google.protobuf.Int32Value max_size_per_document = 10

• optional google.protobuf.BoolValue remove_on_detach = 11

• optional google.protobuf.BoolValue auto_revision_enabled = 22

• 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

• 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

• VALUE_TYPE_INTEGER_DEDUP_CNT = 14

Used in: ChangeID, ChangePack

• map<string, int64> vector = 1

Used in: WatchResponse

• oneof event

  • DocWatchEvent doc_event = 1

  • ChannelWatchEvent channel_event = 2

Used in: WatchResponse

• repeated ResourceInit resource_inits = 1