To stay sane and communicate effectively we try hard to use consistent terminology throughout the pieces of the project. Please let us know if things here are confusing or lacking.
sha1-f1d2d2f924e986ac86fdf7b36c94bcdf32beec15 md5-d3b07384d113edec49eaa6238ad5ff00 sha256-b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944cConcatenating the two together with a hyphen is the common representation, with both parts in all lower case.
The protocol to speak with a blob server is simply:
(Note: no delete operation)
{"camliVersion":Those 16 bytes are the magic number by which a Camli search server can quickly recognize and index schema blobs.
The recommended way to serialize your own Camli schema blobs is to use any exiting JSON serialization library to serialize an object without the camliVersion key, and then manually remove the initial byte of the blob (the {) and prepend the required header:
{ "aKey": "itsValue", "camliType": "foo", "somethingElse": [1, 2, 3] } |
|
{"camliVersion": 1,
"aKey": "itsValue",
"camliType": "foo",
"somethingElse": [1, 2, 3]
} |
A permanode is simply a signed schema blob with no data inside that would be interesting to mutate. See the permanode spec.
A permanent reference to a mutable object then is simply the blobref of the permanode.
The signer of a permanode is its owner and search server and indexer will take this into account. While multiple users may collaborate on mutating an object (by all creating new, signed mutation schema blobs), the owner ultimately decides the policies on how the mutations are respected.
Example permanode blob: (as generated with camput --permanode)
{"camliVersion": 1, "camliSigner": "sha1-c4da9d771661563a27704b91b67989e7ea1e50b8", "camliType": "permanode", "random": "HJ#/s#S+Q$rh:lHJ${)v" ,"camliSig":"iQEcBAABAgAGBQJNQzByAAoJEGjzeDN/6vt85G4IAI9HdygAD8bgz1BnRak6fI+L1dT56MxNsHyAoJaNjYJYKvWR4mrzZonF6l/I7SlvwV4mojofHS21urL8HIGhcMN9dP7Lr9BkCB428kvBtDdazdfN/XVfALVWJOuZEmg165uwTreMOUs377IZom1gjrhnC1bd1VDG7XZ1bP3PPxTxqppM0RuuFWx3/SwixSeWnI+zj9/Qon/wG6M/KDx+cCzuiBwwnpHf8rBmBLNbCs8SVNF3mGwPK0IQq/l4SS6VERVYDPlbBy1hNNdg40MqlJ5jr+Zln3cwF9WzQDznasTs5vK/ylxoXCvVFdOfwBaHkW1NHc3RRpwR0wq2Q8DN3mQ==gR7A"}
Generally a full sync will be done with the blob server's enumerate support and no knowledge of the schema. It's a dumb copy of all blobs that the other party doesn't already have.