envelope.json

{
  "title": "Envelope",
  "description": "The UDMI `envelope` is not a message itself, per se, but the attributes and other information that is delivered along with a message. Read more: <https://github.com/faucetsdn/udmi/blob/master/docs/envelope.md>",
  "additionalProperties": true,
  "properties": {
    "deviceId": {
      "type": "string",
      "pattern": "^[A-Z]{2,6}-[0-9]{1,6}$"
    },
    "deviceNumId": {
      "type": "string",
      "pattern": "^[0-9]+$"
    },
    "deviceRegistryId": {
      "type": "string",
      "pattern": "^[a-zA-Z][-a-zA-Z0-9._+~%]*[a-zA-Z0-9]$"
    },
    "projectId": {
      "type": "string",
      "pattern": "^([.a-z]+:)?[a-z][-a-z0-9]*[a-z0-9]$"
    },
    "subFolder": {
      "enum": [
        "config",
        "discovery",
        "system",
        "metadata",
        "pointset",
        "state"
      ]
    }
  },
  "required": [
    "projectId",
    "deviceRegistryId",
    "deviceNumId",
    "deviceId",
    "subFolder"
  ]
}