@rapharacing/schemas/src/schemas/promotion.json

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

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Code of the promotion"
    },
    "couldFireMessages": {
      "type": "array",
      "description": "Message about promotion which is displayed when planning potential promotion. This field has higher priority over promotion description",
      "items": {
        "type": "string"
      }
    },
    "description": {
      "type": "string",
      "description": "Description of the promotion"
    },
    "enabled": {
      "type": "boolean",
      "description": "Boolean flag if promotion is enabled"
    },
    "endDate": {
      "type": "string",
      "format": "date-time",
      "description": "Last date of validity of the promotion"
    },
    "firedMessages": {
      "type": "array",
      "description": "Message fired while the promotion is active. This is info how much you will get when applying the promotion",
      "items": {
        "type": "string"
      }
    },
    "priority": {
      "type": "integer",
      "format": "int32",
      "description": "Priority index as numeric value of the promotion. Higher number means higher priority"
    },
    "productBanner": {
      "description": "Image banner of the promotion",
      "$ref": "_definitions.json#/definitions/Image",
      "originalRef": "Image"
    },
    "promotionGroup": {
      "type": "string",
      "description": "Group of the promotion"
    },
    "promotionType": {
      "type": "string",
      "description": "Type of the promotion"
    },
    "restrictions": {
      "type": "array",
      "description": "List of promotion restrictions",
      "items": {
        "$ref": "_definitions.json#/definitions/PromotionRestriction",
        "originalRef": "PromotionRestriction"
      }
    },
    "startDate": {
      "type": "string",
      "format": "date-time",
      "description": "The initial date of the promotion"
    },
    "title": {
      "type": "string",
      "description": "Promotion title"
    }
  },
  "title": "Promotion",
  "description": "Representation of a Promotion",
  "$schema": "http://json-schema.org/schema#"
}