Message

A message.

APIs.ioEngineeringPlatform

Properties

Name Type Description
code integer A unique code for this message.
message string A text description of this message.
source object The source of this message.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-rulesets-message-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/rulesets_Message",
  "title": "Message",
  "description": "A message.",
  "properties": {
    "code": {
      "description": "A unique code for this message.",
      "example": 10000,
      "title": "Code",
      "type": "integer"
    },
    "message": {
      "description": "A text description of this message.",
      "example": "something bad happened",
      "minLength": 1,
      "title": "Description",
      "type": "string"
    },
    "source": {
      "description": "The source of this message.",
      "properties": {
        "pointer": {
          "description": "A JSON pointer to the field that is the source of the message.",
          "example": "/rules/0/action",
          "minLength": 1,
          "title": "Pointer",
          "type": "string"
        }
      },
      "required": [
        "pointer"
      ],
      "title": "Source",
      "type": "object"
    }
  },
  "required": [
    "message"
  ],
  "type": "object"
}