navigation.proto RawHistoryFolder

1// Navigation inventory and picker control plane.
2syntax = "proto3";
3
4package vev.wire.v1;
5
6import "common.proto";
7import "session.proto";
8
9option go_package = "github.com/bnema/vev/internal/protocol/wire";
10
11// InventoryEntry is one sanitized public row: display facts only.
12message InventoryEntry {
13  string source_key = 1;
14  string entry_key = 2;
15  string name = 3;
16  string display_origin = 4;
17  string state = 5;
18  string reason = 6;
19}
20
21// InventorySourceGroup is one packed source with its own status.
22message InventorySourceGroup {
23  string source_key = 1;
24  // Closed status taxonomy: 1 = ok, 2 = unavailable, 3 = too large.
25  uint32 status = 2;
26  repeated InventoryEntry entries = 3;
27}
28
29// NavigationInventoryRequest queries a source control connection.
30message NavigationInventoryRequest {
31  uint32 version = 1;
32  uint64 request_id = 2;
33  // Closed operation taxonomy: 1 = snapshot, 2 = resolve.
34  uint32 operation = 3;
35  string source_key = 4;
36  string entry_key = 5;
37  RemoteRegistration registration = 6; // optional pointer
38}
39
40// NavigationInventoryResponse answers a control query: groups for
41// snapshot, one non-mutating AttachTarget for resolve, never both.
42message NavigationInventoryResponse {
43  uint64 request_id = 1;
44  uint32 operation = 2;
45  // Closed status taxonomy: 1 = ok, 2 = unavailable, 3 = invalid,
46  // 4 = version mismatch.
47  uint32 status = 3;
48  repeated InventorySourceGroup groups = 4;
49  AttachTarget resolved = 5; // optional pointer
50}
51
52// NavigationInventoryDemand is serving daemon to client.
53message NavigationInventoryDemand {
54  uint64 interaction_generation = 1;
55  bool open = 2;
56}
57
58// NavigationInventoryPublication is client to serving daemon.
59message NavigationInventoryPublication {
60  uint64 interaction_generation = 1;
61  uint64 publication_generation = 2;
62  repeated InventorySourceGroup groups = 3;
63}
64
65// NavigationInventorySelection is serving daemon to client.
66message NavigationInventorySelection {
67  uint64 cause_action_id = 1;
68  uint64 interaction_generation = 2;
69  uint64 publication_generation = 3;
70  string source_key = 4;
71  string entry_key = 5;
72}
73
74// NavigationInventoryFailure is client to serving daemon.
75message NavigationInventoryFailure {
76  uint64 cause_action_id = 1;
77  uint64 interaction_generation = 2;
78  string source_key = 3;
79  string entry_key = 4;
80  // Closed code taxonomy: 1 = stale identity, 2 = source gone,
81  // 3 = incompatible, 4 = invalid target, 5 = navigation failed,
82  // 6 = restore failed.
83  uint32 code = 5;
84}