summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Pointner <equinox@spreadspace.org>2017-04-30 02:54:38 +0200
committerChristian Pointner <equinox@spreadspace.org>2017-04-30 02:54:38 +0200
commitb23a508d45ce6d7d6a720dc734f88f2ce1fac85f (patch)
tree1595e17f2811822c801a0bdd3aa077d9253da6bf /doc
parentfixed last commit (diff)
improved protocol docs
Diffstat (limited to 'doc')
-rw-r--r--doc/protocol.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/protocol.md b/doc/protocol.md
index fdd51ee..ff0cc51 100644
--- a/doc/protocol.md
+++ b/doc/protocol.md
@@ -4,7 +4,7 @@ Messages
init
----
-All fields except version are optional. The values in this message are treated as
+All fields except "version" are optional. The values in this message are treated as
defaults which will be used if the corresponding value is missing in subsequent
update messages.
@@ -24,6 +24,9 @@ values from data updates override values from init. Stateless interfaces will no
init messages and therefore all values must be defined here.
If an interface (i.e. REST) has other means to detect protocol versions the version
field may be omitted entirely.
+"SourceHubUuid", "SourceHubDataUpdateId", "user-agent", "bytes-received", "tags" and
+"clients" might be omitted and are treated as an empty string, 0 or empty array
+respectively.
The start-time will be processesd and stored with millisecond precision.
{