Services/Sync/Developer/StorageFormat

From MozillaWiki
< Services‎ | Sync
Revision as of 19:31, 29 March 2010 by Mardak (talk | contribs) (add more structure)
Jump to navigation Jump to search

Under a user's /storage path, there's a set of well-known records and storage formats used by the Weave Sync add-on. This document describes those records and their formats, e.g., JS-object format of the JSON-string payload.

Weave Basic Object

All records from the server come back as a JSON string that represent a JS-object with some attributes.

Version 2

Changes from v1 -> v2

Version 1

Encrypted Data Object

Individual data engines, e.g., bookmarks, encrypt their BrowserObjects payloads before packing it into a Weave Basic Object.

Version 2

Changes from v1 -> v2

Version 1

Payload: meta/global

The payload of the meta/global record contains general metadata to describe data like versions and syncID.

Version 2

storageVersion int:
syncID string:
engines object:

Changes from v1 -> v2

Version 1

storageVersion string:
syncID string:

Payload: keys/pubkey

Version 2

Changes from v1 -> v2

Version 1

Payload: keys/privkey

Version 2

Changes from v1 -> v2

Version 1

Payload: crypto/<engine>

Version 2

Changes from v1 -> v2

Version 1