codemp-proto 0.8.0

protocol definitions for codemp -- code multiplexer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

syntax = "proto2";

package workspace;

import "common.proto";
import "files.proto";

// Handles workspace state management.
service Workspace {
	// Attach to a workspace.
	rpc Attach (common.Empty) returns (stream WorkspaceEvent);
	// Create a buffer within the workspace.
	rpc CreateBuffer (files.BufferNode) returns (common.Empty);
	// Access a buffer within the workspace and returns a buffer token for it.
	rpc AccessBuffer (files.BufferNode) returns (common.Token);
	// Transforms an ephemeral buffer in a persistent one.
	rpc PinBuffer (files.BufferRequest) returns (common.Empty);
	// Delete a buffer.
	rpc DeleteBuffer (files.BufferRequest) returns (common.Empty);
	// List buffers in the workspace that are children of the given path.
	rpc ListBuffers (files.BufferRequest) returns (files.BufferTree); 
	// List users in the workspace.
	rpc ListUsers (common.Empty) returns (UserList);
	// List users within a given buffer.
	rpc ListBufferUsers (files.BufferRequest) returns (UserList);
	// Revokes all invites and kicks all active users.
	rpc KickAll (common.Empty) returns (common.Empty);
}

// A message representing a list of users.
message UserList {
	// A vector of users.
	repeated common.User users = 1;
}

// A message representing a workspace event.
message WorkspaceEvent {
	// Event that occurs when a user joins a workspace.
	message UserJoin {
		// The user that joined.
		required common.User user = 1;
	}
	// Event that occurs when a user leaves a workspace.
	message UserLeave {
		// The user that left.
		required common.User user = 1;
	}
	// Event that occurs when a file is created in a workspace.
	message FileCreate {
		// The path of the created file.
		required string path = 1;
		// Whether the buffer is ephemeral.
		required bool ephemeral = 2;
	}
	// Event that occurs when a file is renamed in a workspace.
	message FileRename {
		// The old path of the file.
		required string before = 1;
		// The new path of the file.
		required string after = 2;
	}
	// Event that occurs when a file is deleted in a workspace.
	message FileDelete {
		// The path of the deleted file
		required string path = 1;
	}

	// The union containing actual event.
	oneof event {
		UserJoin join = 1;
		UserLeave leave = 2;
		FileCreate create = 3;
		FileRename rename = 4;
		FileDelete delete = 5;
	}
}