commy-wire 0.2.1

Commy wire contract (spec, JSON Schema, golden vectors, shared Rust wire types).
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/ThinkersJournal/commy-wire/schema/control.schema.json",
  "title": "Commy control message (draft 1)",
  "oneOf": [
    {
      "properties": {
        "type": { "const": "Authenticate" },
        "data": {
          "type": "object",
          "required": ["request_id", "protocol_version", "tenant_id", "client_id", "auth_method", "credentials"],
          "properties": {
            "request_id": { "type": "string" },
            "protocol_version": { "type": "integer", "minimum": 0, "maximum": 4294967295 },
            "tenant_id": { "type": "string" },
            "client_id": { "type": "string" },
            "auth_method": { "type": "string" },
            "credentials": { "type": "string" }
          },
          "additionalProperties": false
        }
      }
    },
    {
      "properties": {
        "type": { "const": "FlushAck" },
        "data": {
          "type": "object",
          "required": ["request_id", "file_id", "seq"],
          "properties": {
            "request_id": { "type": "string" },
            "file_id": { "type": "integer", "minimum": 0, "maximum": 4294967295 },
            "seq": { "type": "integer", "minimum": 0 }
          },
          "additionalProperties": false
        }
      }
    },
    {
      "properties": {
        "type": { "const": "Resync" },
        "data": {
          "type": "object",
          "required": ["request_id", "file_id"],
          "properties": {
            "request_id": { "type": "string" },
            "file_id": { "type": "integer", "minimum": 0, "maximum": 4294967295 }
          },
          "additionalProperties": false
        }
      }
    },
    {
      "properties": {
        "type": { "const": "ResyncDone" },
        "data": {
          "type": "object",
          "required": ["request_id", "file_id", "seq", "size"],
          "properties": {
            "request_id": { "type": "string" },
            "file_id": { "type": "integer", "minimum": 0, "maximum": 4294967295 },
            "seq": { "type": "integer", "minimum": 0 },
            "size": { "type": "integer", "minimum": 0 }
          },
          "additionalProperties": false
        }
      }
    },
    {
      "properties": {
        "type": { "const": "GetServiceFilePath" },
        "data": {
          "type": "object",
          "required": ["request_id", "service_id"],
          "properties": { "request_id": { "type": "string" }, "service_id": { "type": "string" } },
          "additionalProperties": false
        }
      }
    },
    {
      "properties": {
        "type": { "const": "ServiceFilePath" },
        "data": {
          "type": "object",
          "required": ["request_id", "service_id", "file_id"],
          "properties": {
            "request_id": { "type": "string" },
            "service_id": { "type": "string" },
            "file_id": { "type": "integer", "minimum": 0, "maximum": 4294967295 },
            "path": { "type": "string" },
            "nonce_path": { "type": "string" }
          },
          "dependentRequired": { "path": ["nonce_path"], "nonce_path": ["path"] },
          "additionalProperties": false
        }
      }
    },
    {
      "properties": {
        "type": { "const": "ConfirmLocal" },
        "data": {
          "type": "object",
          "required": ["request_id", "file_id", "nonce"],
          "properties": {
            "request_id": { "type": "string" },
            "file_id": { "type": "integer", "minimum": 0, "maximum": 4294967295 },
            "nonce": { "type": "string" }
          },
          "additionalProperties": false
        }
      }
    },
    {
      "properties": {
        "type": { "const": "ConfirmLocalAck" },
        "data": {
          "type": "object",
          "required": ["request_id", "file_id"],
          "properties": {
            "request_id": { "type": "string" },
            "file_id": { "type": "integer", "minimum": 0, "maximum": 4294967295 }
          },
          "additionalProperties": false
        }
      }
    },
    { "$ref": "error.schema.json" }
  ],
  "required": ["type", "data"]
}