services/sync/tests/unit/sync_ping_schema.json
author Mark Hammond <mhammond@skippinet.com.au>
Fri, 04 Nov 2016 17:57:09 +1100
changeset 457463 339a0501a0dd6edc1917104067ab281c0c567f5b
parent 457032 801e4543e990929e6bb076a032774b788e612937
child 459402 0aad3ebe6f6e8ea6170d7cbb933edd1e438b5e5a
child 469815 3fb202d2ca0e7f0d703f178f0dbb6585b36d2ea7
permissions -rw-r--r--
Bug 1289536 (part 1) - Add events to Sync ping. r?gfritzsche MozReview-Commit-ID: 184fIhelOa6

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "schema for Sync pings, documentation avaliable in toolkit/components/telemetry/docs/sync-ping.rst",
  "type": "object",
  "additionalProperties": false,
  "required": ["version", "syncs", "why", "uid"],
  "properties": {
    "version": { "type": "integer", "minimum": 0 },
    "discarded": { "type": "integer", "minimum": 1 },
    "why": { "enum": ["shutdown", "schedule", "idchange"] },
    "uid": {
      "type": "string",
      "pattern": "^[0-9a-f]{32}$"
    },
    "deviceID": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$"
    },
    "syncs": {
      "type": "array",
      "minItems": 1,
      "items": { "$ref": "#/definitions/payload" }
    },
    "events": {
      "type": "array",
      "minItems": 1,
      "items": { "$ref": "#/definitions/event" }
    }
  },
  "definitions": {
    "payload": {
      "type": "object",
      "additionalProperties": false,
      "required": ["when", "took"],
      "properties": {
        "didLogin": { "type": "boolean" },
        "when": { "type": "integer" },
        "devices": {
          "type": "array",
          "items": { "$ref": "#/definitions/device" }
        },
        "status": {
          "type": "object",
          "anyOf": [
            { "required": ["sync"] },
            { "required": ["service"] }
          ],
          "additionalProperties": false,
          "properties": {
            "sync": { "type": "string" },
            "service": { "type": "string" }
          }
        },
        "why": { "enum": ["startup", "schedule", "score", "user", "tabs"] },
        "took": { "type": "integer", "minimum": -1 },
        "failureReason": { "$ref": "#/definitions/error" },
        "engines": {
          "type": "array",
          "minItems": 1,
          "items": { "$ref": "#/definitions/engine" }
        }
      }
    },
    "device": {
      "required": ["os", "id", "version"],
      "additionalProperties": false,
      "type": "object",
      "properties": {
        "id": { "type": "string", "pattern": "^[0-9a-f]{64}$" },
        "os": { "type": "string" },
        "version": { "type": "string" }
      }
    },
    "engine": {
      "required": ["name"],
      "additionalProperties": false,
      "properties": {
        "failureReason": { "$ref": "#/definitions/error" },
        "name": { "enum": ["addons", "bookmarks", "clients", "forms", "history", "passwords", "prefs", "tabs"] },
        "took": { "type": "integer", "minimum": 1 },
        "status": { "type": "string" },
        "incoming": {
          "type": "object",
          "additionalProperties": false,
          "anyOf": [
            {"required": ["applied"]},
            {"required": ["failed"]},
            {"required": ["newFailed"]},
            {"required": ["reconciled"]}
          ],
          "properties": {
            "applied": { "type": "integer", "minimum": 1 },
            "failed": { "type": "integer", "minimum": 1 },
            "newFailed": { "type": "integer", "minimum": 1 },
            "reconciled": { "type": "integer", "minimum": 1 }
          }
        },
        "outgoing": {
          "type": "array",
          "minItems": 1,
          "items": { "$ref": "#/definitions/outgoingBatch" }
        },
        "validation": {
          "type": "object",
          "additionalProperties": false,
          "anyOf": [
            { "required": ["checked"] },
            { "required": ["failureReason"] }
          ],
          "properties": {
            "checked": { "type": "integer", "minimum": 0 },
            "failureReason": { "$ref": "#/definitions/error" },
            "took": { "type": "integer" },
            "version": { "type": "integer" },
            "problems": {
              "type": "array",
              "minItems": 1,
              "$ref": "#/definitions/validationProblem"
            }
          }
        }
      }
    },
    "outgoingBatch": {
      "type": "object",
      "additionalProperties": false,
      "anyOf": [
        {"required": ["sent"]},
        {"required": ["failed"]}
      ],
      "properties": {
        "sent": { "type": "integer", "minimum": 1 },
        "failed": { "type": "integer", "minimum": 1 }
      }
    },
    "event": {
      "type": "array",
      "minItems": 4,
      "maxItems": 6
    },
    "error": {
      "oneOf": [
        { "$ref": "#/definitions/httpError" },
        { "$ref": "#/definitions/nsError" },
        { "$ref": "#/definitions/shutdownError" },
        { "$ref": "#/definitions/authError" },
        { "$ref": "#/definitions/otherError" },
        { "$ref": "#/definitions/unexpectedError" },
        { "$ref": "#/definitions/sqlError" }
      ]
    },
    "httpError": {
      "required": ["name", "code"],
      "properties": {
        "name": { "enum": ["httperror"] },
        "code": { "type": "integer" }
      }
    },
    "nsError": {
      "required": ["name", "code"],
      "properties": {
        "name": { "enum": ["nserror"] },
        "code": { "type": "integer" }
      }
    },
    "shutdownError": {
      "required": ["name"],
      "properties": {
        "name": { "enum": ["shutdownerror"] }
      }
    },
    "authError": {
      "required": ["name"],
      "properties": {
        "name": { "enum": ["autherror"] },
        "from": { "enum": ["tokenserver", "fxaccounts", "hawkclient"] }
      }
    },
    "otherError": {
      "required": ["name"],
      "properties": {
        "name": { "enum": ["othererror"] },
        "error": { "type": "string" }
      }
    },
    "unexpectedError": {
      "required": ["name"],
      "properties": {
        "name": { "enum": ["unexpectederror"] },
        "error": { "type": "string" }
      }
    },
    "sqlError": {
      "required": ["name"],
      "properties": {
        "name": { "enum": ["sqlerror"] },
        "code": { "type": "integer" }
      }
    },
    "validationProblem": {
      "required": ["name", "count"],
      "properties": {
        "name": { "type": "string" },
        "count": { "type": "integer" }
      }
    }
  }
}