Schema error-message.json

Resolve referenced schemas (may reorder keys)

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Error protocol message structure - used by devices to return general error messages for example when incoming messages do not have messageType, handles or contain invalid JSON",
  "title": "Error protocol message",
  "allOf": [
    {
      "$ref": "base-message.json"
    },
    {
      "type": "object",
      "required": [
        "status",
        "errorMessage",
        "messageType"
      ],
      "properties": {
        "status": {
          "type": "integer",
          "description": "Status of the message response. Must include the numeric values for NcMethodStatus or other types which inherit from it.",
          "minimum": 0,
          "maximum": 65535
        },
        "errorMessage": {
          "description": "Error details associated with the failure",
          "type": "string"
        },
        "messageType": {
          "description": "Protocol message type",
          "type": "integer",
          "enum": [
            5
          ]
        }
      }
    }
  ]
}

​x
 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Error protocol message structure - used by devices to return general error messages for example when incoming messages do not have messageType, handles or contain invalid JSON",
  "title": "Error protocol message",
  "allOf": [
    {
      "$ref": "base-message.json"
    },
    {
      "type": "object",
      "required": [
        "status",
        "errorMessage",
        "messageType"
      ],
      "properties": {
        "status": {
          "type": "integer",
          "description": "Status of the message response. Must include the numeric values for NcMethodStatus or other types which inherit from it.",
          "minimum": 0,
          "maximum": 65535
        },
        "errorMessage": {
          "description": "Error details associated with the failure",
          "type": "string"
        },
        "messageType": {
          "description": "Protocol message type",
          "type": "integer",
          "enum": [
            5
          ]
        }
      }
    }
  ]
}
​

Documentation built at 04:52:03 CDT on 2024-08-29.
(c) AMWA 2024. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.