@rapharacing/schemas/dist/schemas/address.json

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

{
  "type": "object",
  "required": [
    "firstName",
    "lastName",
    "line1",
    "postalCode",
    "titleCode",
    "town"
  ],
  "properties": {
    "cellphone": {
      "type": "string",
      "description": "Cellphone number"
    },
    "companyName": {
      "type": "string",
      "description": "Company Name"
    },
    "country": {
      "description": "Country where address is located",
      "$ref": "_definitions.json#/definitions/Country",
      "originalRef": "Country"
    },
    "defaultAddress": {
      "type": "boolean",
      "description": "Boolean flag if address is default"
    },
    "district": {
      "type": "string",
      "description": "District name"
    },
    "email": {
      "type": "string",
      "description": "Email address"
    },
    "firstName": {
      "type": "string",
      "description": "First name of the address person"
    },
    "formattedAddress": {
      "type": "string",
      "description": "Boolean flag if address is formatted"
    },
    "id": {
      "type": "string",
      "description": "Unique id value of the address which is optional while creating new address. While performing other address operations this value is the key"
    },
    "lastName": {
      "type": "string",
      "description": "Last name of the address person"
    },
    "line1": {
      "type": "string",
      "description": "First line of the address"
    },
    "line2": {
      "type": "string",
      "description": "Second line of the address"
    },
    "phone": {
      "type": "string",
      "description": "Phone number"
    },
    "postalCode": {
      "type": "string",
      "description": "Postal code of the address"
    },
    "region": {
      "description": "Region where address belongs to",
      "$ref": "_definitions.json#/definitions/Region",
      "originalRef": "Region"
    },
    "shippingAddress": {
      "type": "boolean",
      "description": "Boolean flag if address is for shipping"
    },
    "title": {
      "type": "string",
      "description": "Title of the address person"
    },
    "titleCode": {
      "type": "string",
      "description": "Code of the title"
    },
    "town": {
      "type": "string",
      "description": "Town, field required"
    },
    "visibleInAddressBook": {
      "type": "boolean",
      "description": "Boolean flag if address is visible in the Address Book"
    }
  },
  "title": "Address",
  "description": "Request body fields required and optional to operate on address data. The DTO is in XML or .json format",
  "$schema": "http://json-schema.org/schema#"
}