|
3 | 3 | "id": "http://jsonschema.net", |
4 | 4 | "type": "object", |
5 | 5 | "title": "Root schema.", |
6 | | - "description": "An explanation about the puropose of this instance described by this schema.", |
| 6 | + "description": "OpenKnot Communications Platform Schema: https://github.com/openknot/openknot/blob/master/schemas/message.json", |
7 | 7 | "name": "/", |
8 | 8 | "properties": { |
9 | 9 | "message": { |
10 | 10 | "id": "http://jsonschema.net/message", |
11 | 11 | "type": "object", |
12 | 12 | "title": "Message schema.", |
13 | | - "description": "An explanation about the puropose of this instance described by this schema.", |
| 13 | + "description": "All messages sent/received by OpenKnot should be serializable to this schema", |
14 | 14 | "name": "message", |
15 | 15 | "properties": { |
16 | 16 | "id": { |
17 | 17 | "id": "http://jsonschema.net/message/id", |
18 | | - "type": "integer", |
| 18 | + "type": "string", |
19 | 19 | "title": "Id schema.", |
20 | | - "description": "An explanation about the puropose of this instance described by this schema.", |
| 20 | + "description": "A UUID for this message: 32 lowercase hexadecimal digits, displayed in five groups separated by hyphens, in the form 8-4-4-4-12", |
21 | 21 | "name": "id", |
22 | | - "default": 1234 |
| 22 | + "default": "00000000-0000-0000-0000-000000000000" |
23 | 23 | }, |
24 | 24 | "timestamp": { |
25 | 25 | "id": "http://jsonschema.net/message/timestamp", |
26 | 26 | "type": "string", |
27 | 27 | "title": "Timestamp schema.", |
28 | | - "description": "An explanation about the puropose of this instance described by this schema.", |
| 28 | + "description": "ISO8601 formatted datetime with millisecond precision ALWAYS expressed as UTC", |
29 | 29 | "name": "timestamp", |
30 | | - "default": "2015-08-01 00:00:00 +1000" |
| 30 | + "default": "2015-08-04T14:23:19.234Z" |
31 | 31 | }, |
32 | 32 | "protocol": { |
33 | 33 | "id": "http://jsonschema.net/message/protocol", |
34 | 34 | "type": "string", |
35 | | - "title": "Protocol schema.", |
36 | | - "description": "An explanation about the puropose of this instance described by this schema.", |
| 35 | + "title": "Initial Protocol Schema.", |
| 36 | + "description": "The protocol that was originally used to create the message: IRC/NNTP/XMPP/SMTP/etc.", |
37 | 37 | "name": "protocol", |
38 | 38 | "default": "IRC" |
39 | 39 | }, |
40 | 40 | "source": { |
41 | 41 | "id": "http://jsonschema.net/message/source", |
42 | 42 | "type": "string", |
43 | 43 | "title": "Source schema.", |
44 | | - "description": "An explanation about the puropose of this instance described by this schema.", |
| 44 | + "description": "The identifier for the Agent that created the message", |
45 | 45 | "name": "source", |
46 | 46 | "default": "prologic" |
47 | 47 | }, |
48 | | - "targets": { |
49 | | - "id": "http://jsonschema.net/message/targets", |
| 48 | + "destinations": { |
| 49 | + "id": "http://jsonschema.net/message/destinations", |
50 | 50 | "type": "array", |
51 | | - "title": "Targets schema.", |
52 | | - "description": "An explanation about the puropose of this instance described by this schema.", |
53 | | - "name": "targets", |
| 51 | + "title": "Destinations schema.", |
| 52 | + "description": "A list of destination Agents to which the message should be delivered", |
| 53 | + "name": "destinations", |
54 | 54 | "items": { |
55 | | - "id": "http://jsonschema.net/message/targets/0", |
| 55 | + "id": "http://jsonschema.net/message/destinations/0", |
56 | 56 | "type": "string", |
57 | 57 | "title": "0 schema.", |
58 | | - "description": "An explanation about the puropose of this instance described by this schema.", |
| 58 | + "description": "The Agent identifier for this destination for this message", |
59 | 59 | "name": "0", |
60 | 60 | "default": "#openknot" |
61 | 61 | } |
|
64 | 64 | "id": "http://jsonschema.net/message/content", |
65 | 65 | "type": "string", |
66 | 66 | "title": "Content schema.", |
67 | | - "description": "An explanation about the puropose of this instance described by this schema.", |
| 67 | + "description": "The content of the message, including any headers by extension", |
68 | 68 | "name": "content", |
69 | 69 | "default": "Test!" |
70 | 70 | } |
|
74 | 74 | "timestamp", |
75 | 75 | "protocol", |
76 | 76 | "source", |
77 | | - "targets", |
| 77 | + "destinations", |
78 | 78 | "content" |
79 | 79 | ] |
80 | 80 | } |
|
0 commit comments