@rapharacing/schemas/src/schemas/consignmenttracking.json

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

{
  "type": "object",
  "properties": {
    "carrierDetails": {
      "description": "Carrier details",
      "$ref": "_definitions.json#/definitions/carrier",
      "originalRef": "carrier"
    },
    "statusDisplay": {
      "type": "string",
      "example": "inTransit",
      "description": "Consignment status"
    },
    "targetArrivalDate": {
      "type": "string",
      "format": "date-time",
      "description": "Target arrival date"
    },
    "trackingEvents": {
      "type": "array",
      "description": "Logistics tracking information",
      "items": {
        "$ref": "_definitions.json#/definitions/consignmentTrackingEvent",
        "originalRef": "consignmentTrackingEvent"
      }
    },
    "trackingID": {
      "type": "string",
      "description": "Tracking identifier"
    },
    "trackingUrl": {
      "type": "string",
      "description": "The tracking url provided by the carrier"
    }
  },
  "title": "consignmentTracking",
  "description": "Consignment tracking data",
  "$schema": "http://json-schema.org/schema#"
}