@rapharacing/schemas/src/schemas/voucher.json

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

{
  "type": "object",
  "properties": {
    "appliedValue": {
      "description": "Applied value when using this voucher",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "code": {
      "type": "string",
      "description": "The identifier of the Voucher. This is the first part of voucher code which holds first 3 letters, like: 123"
    },
    "currency": {
      "description": "Currency of the voucher",
      "$ref": "_definitions.json#/definitions/Currency",
      "originalRef": "Currency"
    },
    "description": {
      "type": "string",
      "description": "Description of the voucher"
    },
    "freeShipping": {
      "type": "boolean",
      "description": "Specifies if the order this voucher is applied to is shipped for free (true) or not (false). Defaults to false."
    },
    "name": {
      "type": "string",
      "description": "Name of the voucher"
    },
    "value": {
      "type": "number",
      "format": "double",
      "description": "Value of the voucher. Example of such value is: 15.0d"
    },
    "valueFormatted": {
      "type": "string",
      "description": "Formatted value of the voucher"
    },
    "valueString": {
      "type": "string",
      "description": "The value of the voucher to display. Example: 15.0%"
    },
    "voucherCode": {
      "type": "string",
      "description": "Voucher code, is the holder for keeping specific occasional voucher related to business usage. It can be generated and looks like: 123-H8BC-Y3D5-34AL"
    }
  },
  "title": "Voucher",
  "description": "Representation of a Voucher",
  "$schema": "http://json-schema.org/schema#"
}