@rapharacing/schemas/src/schemas/error.json

OpenAPI to JSON Schema to be used with middy for CC response validation

{
  "type": "object",
  "properties": {
    "errorCode": {
      "type": "string",
      "description": "Error code"
    },
    "message": {
      "type": "string",
      "description": "Descriptive, human readable error message."
    },
    "reason": {
      "type": "string",
      "description": "Additional classification specific for each error type e.g. 'noStock'."
    },
    "subject": {
      "type": "string",
      "description": "Identifier of the related object e.g. '1'."
    },
    "subjectType": {
      "type": "string",
      "description": "Type of the object related to the error e.g. 'entry'."
    },
    "type": {
      "type": "string",
      "description": "Type of the error e.g. 'LowStockError'."
    }
  },
  "title": "error",
  "description": "Error message",
  "$schema": "http://json-schema.org/schema#"
}