black-box-latest-data-query-schema.json

{
  "id": "ropod-cmd-schema.json",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title" : "Black Box Latest Data Query Schema",
  "description": "Retrieve latest datum for each of a set of variables logged on a black box",
  "type": "object",

  "properties":
  {
    "header":
    {
      "allOf":
      [
        { "$ref": "ropod-msg-schema.json#/definitions/header" },
        { "$ref": "#/definitions/header" }
      ]
    },

    "payload":
    {
      "allOf":
      [
        { "$ref": "ropod-msg-schema.json#/definitions/payload" },
        { "$ref": "#/definitions/bbLatestDataQueryPayload" }
      ]
    }
  },

  "required": [ "header", "payload" ],
  "additionalProperties": true,

  "definitions":
  {
    "header":
    {
      "type": "object",
      "description": "More specific definition (than the definition of ropod-msg-schema.json). Only the type field is further specified.",
      "properties":
      {
        "type": { "enum": [ "LATEST-DATA-QUERY" ] }
      },
      "required": [ "type"],
      "additionalProperties": true
    },

    "bbLatestDataQueryPayload":
    {
      "type": "object",
      "description": "Data associated with a black box data query (e.g. who is requesting the data, and variables for which to retrieve data).",
      "properties":
      {
        "senderId":   { "$ref": "#/definitions/senderId" },
        "ropodId":   { "$ref": "#/definitions/ropodId" },
        "variables":   { "$ref": "#/definitions/variables" },
      },
      "required": [ "senderId", "ropodId", "variables"],
      "additionalProperties": false
    },

    "senderId":
    {
      "description": "ID uniquely specifying the client that requests black box data."
    },

    "ropodId":
    {
      "type": "string",
      "description": "ID of the ropod to which the queried black box is attached."
    },

    "variables":
    {
      "type": "array",
      "items":
      {
        "type": "string"
      },
      "description": "A list of variables names for which data should be retrieved."
    }
  }
}