Catalog Event Definition 0.1.0

Accepts one of the following messages:

• #0

  • application/json

  Message IDProductCreated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new catalog events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/catalog-service"

  type

  required

  string

  Const:"com.specsavers.rtp.catalog.product.created"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"product"

  productTypeKey

  required

  string

  The key of the product type of the product. E.g. ABC123

  productGroup

  required

  string

  The product group the product belongs to

  Allowed values:
  • "frame"
  • "contact-lens"
  • "accessory"
  • "audio"
  • "other"

  id

  string

  The ID of the asset. E.g. 1234

  version

  number

  The version of the asset. E.g. 1

  createdAt

  string

  format: date-time

  The creation date of the asset. E.g. 2021-01-01T00:00:00Z

  updatedAt

  string

  format: date-time

  The last update date of the asset. E.g. 2021-01-01T00:00:00Z

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #catalog

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/catalog-service",
    "type": "com.specsavers.rtp.catalog.product.created",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "product",
      "productTypeKey": "string",
      "productGroup": "frame",
      "id": "string",
      "version": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
  

  This example has been generated automatically.

• #1

  • application/json

  Message IDProductUpdated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new catalog events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/catalog-service"

  type

  required

  string

  Const:"com.specsavers.rtp.catalog.product.updated"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"product"

  productTypeKey

  required

  string

  The key of the product type of the product. E.g. ABC123

  productGroup

  required

  string

  The product group the product belongs to

  Allowed values:
  • "frame"
  • "contact-lens"
  • "accessory"
  • "audio"
  • "other"

  id

  string

  The ID of the asset. E.g. 1234

  version

  number

  The version of the asset. E.g. 1

  createdAt

  string

  format: date-time

  The creation date of the asset. E.g. 2021-01-01T00:00:00Z

  updatedAt

  string

  format: date-time

  The last update date of the asset. E.g. 2021-01-01T00:00:00Z

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #catalog

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/catalog-service",
    "type": "com.specsavers.rtp.catalog.product.updated",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "product",
      "productTypeKey": "string",
      "productGroup": "frame",
      "id": "string",
      "version": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
  

  This example has been generated automatically.

• #2

  • application/json

  Message IDProductDeleted

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new catalog events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/catalog-service"

  type

  required

  string

  Const:"com.specsavers.rtp.catalog.product.deleted"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"product"

  productTypeKey

  required

  string

  The key of the product type of the product. E.g. ABC123

  productGroup

  required

  string

  The product group the product belongs to

  Allowed values:
  • "frame"
  • "contact-lens"
  • "accessory"
  • "audio"
  • "other"

  id

  string

  The ID of the asset. E.g. 1234

  version

  number

  The version of the asset. E.g. 1

  createdAt

  string

  format: date-time

  The creation date of the asset. E.g. 2021-01-01T00:00:00Z

  updatedAt

  string

  format: date-time

  The last update date of the asset. E.g. 2021-01-01T00:00:00Z

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #catalog

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/catalog-service",
    "type": "com.specsavers.rtp.catalog.product.deleted",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "product",
      "productTypeKey": "string",
      "productGroup": "frame",
      "id": "string",
      "version": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
  

  This example has been generated automatically.

• #3

  • application/json

  Message IDCategoryCreated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new catalog events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/catalog-service"

  type

  required

  string

  Const:"com.specsavers.rtp.catalog.category.created"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"category"

  id

  string

  The ID of the asset. E.g. 1234

  version

  number

  The version of the asset. E.g. 1

  createdAt

  string

  format: date-time

  The creation date of the asset. E.g. 2021-01-01T00:00:00Z

  updatedAt

  string

  format: date-time

  The last update date of the asset. E.g. 2021-01-01T00:00:00Z

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #catalog

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/catalog-service",
    "type": "com.specsavers.rtp.catalog.category.created",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "category",
      "id": "string",
      "version": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
  

  This example has been generated automatically.

• #4

  • application/json

  Message IDCategoryUpdated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new catalog events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/catalog-service"

  type

  required

  string

  Const:"com.specsavers.rtp.catalog.category.updated"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"category"

  id

  string

  The ID of the asset. E.g. 1234

  version

  number

  The version of the asset. E.g. 1

  createdAt

  string

  format: date-time

  The creation date of the asset. E.g. 2021-01-01T00:00:00Z

  updatedAt

  string

  format: date-time

  The last update date of the asset. E.g. 2021-01-01T00:00:00Z

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #catalog

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/catalog-service",
    "type": "com.specsavers.rtp.catalog.category.updated",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "category",
      "id": "string",
      "version": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
  

  This example has been generated automatically.

• #5

  • application/json

  Message IDCategoryDeleted

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new catalog events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/catalog-service"

  type

  required

  string

  Const:"com.specsavers.rtp.catalog.category.deleted"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"category"

  id

  string

  The ID of the asset. E.g. 1234

  version

  number

  The version of the asset. E.g. 1

  createdAt

  string

  format: date-time

  The creation date of the asset. E.g. 2021-01-01T00:00:00Z

  updatedAt

  string

  format: date-time

  The last update date of the asset. E.g. 2021-01-01T00:00:00Z

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #catalog

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/catalog-service",
    "type": "com.specsavers.rtp.catalog.category.deleted",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "category",
      "id": "string",
      "version": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
  

  This example has been generated automatically.

• #6

  • application/json

  Message IDProductTypeCreated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new catalog events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/catalog-service"

  type

  required

  string

  Const:"com.specsavers.rtp.catalog.product-type.created"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"product-type"

  id

  string

  The ID of the asset. E.g. 1234

  version

  number

  The version of the asset. E.g. 1

  createdAt

  string

  format: date-time

  The creation date of the asset. E.g. 2021-01-01T00:00:00Z

  updatedAt

  string

  format: date-time

  The last update date of the asset. E.g. 2021-01-01T00:00:00Z

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #catalog

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/catalog-service",
    "type": "com.specsavers.rtp.catalog.product-type.created",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "product-type",
      "id": "string",
      "version": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
  

  This example has been generated automatically.

• #7

  • application/json

  Message IDProductTypeUpdated

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new catalog events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/catalog-service"

  type

  required

  string

  Const:"com.specsavers.rtp.catalog.product-type.updated"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"product-type"

  id

  string

  The ID of the asset. E.g. 1234

  version

  number

  The version of the asset. E.g. 1

  createdAt

  string

  format: date-time

  The creation date of the asset. E.g. 2021-01-01T00:00:00Z

  updatedAt

  string

  format: date-time

  The last update date of the asset. E.g. 2021-01-01T00:00:00Z

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #catalog

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/catalog-service",
    "type": "com.specsavers.rtp.catalog.product-type.updated",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "product-type",
      "id": "string",
      "version": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
  

  This example has been generated automatically.

• #8

  • application/json

  Message IDProductTypeDeleted

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new catalog events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/catalog-service"

  type

  required

  string

  Const:"com.specsavers.rtp.catalog.product-type.deleted"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  The key of the asset. E.g. ABC123

  assetType

  required

  string

  Const:"product-type"

  id

  string

  The ID of the asset. E.g. 1234

  version

  number

  The version of the asset. E.g. 1

  createdAt

  string

  format: date-time

  The creation date of the asset. E.g. 2021-01-01T00:00:00Z

  updatedAt

  string

  format: date-time

  The last update date of the asset. E.g. 2021-01-01T00:00:00Z

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #catalog

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/catalog-service",
    "type": "com.specsavers.rtp.catalog.product-type.deleted",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "product-type",
      "id": "string",
      "version": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
  

  This example has been generated automatically.

• #9

  • application/json

  Message IDTalonOneSyncEvent

  Correlation ID$message.payload#/detail/correlationid

  Default Correlation ID

  The application will send new Talon One sync events through this channel.

  Payload

  Expand all

  object

  id

  required

  string

  specversion

  required

  string

  Default value:"1.0"

  env

  required

  string

  The environment from which the event originated from e.g. dev, prod

  Allowed values:
  • "dev"
  • "qa"
  • "qa2"
  • "stg"
  • "prod"

  sourceService

  string

  Const:"com.specsavers/catalog-service"

  type

  required

  string

  Allowed values:
  • "com.specsavers.rtp.catalog.talon-one.product.updated"
  • "com.specsavers.rtp.catalog.talon-one.product.created"
  • "com.specsavers.rtp.catalog.talon-one.product.deleted"

  correlationid

  required

  string

  The correlation ID of the event. E.g. 1234

  data

  Expand all

  required

  object

  assetKey

  required

  string

  assetType

  required

  string

  Allowed values:
  • "product"

  productTypeKey

  required

  string

  The key of the product type of the product. E.g. ABC123

  productGroup

  required

  string

  The product group the product belongs to

  Allowed values:
  • "frame"
  • "contact-lens"
  • "accessory"
  • "audio"
  • "other"

  isFromFullSync

  required

  boolean

  Whether the event is from a full sync

  Additional properties are NOT allowed.

  Extensions

  x-envelope-type

  cloudevent

  Additional properties are allowed.

  • #content

  Examples

  Payload

  {
    "id": "string",
    "specversion": "1.0",
    "env": "dev",
    "sourceService": "com.specsavers/catalog-service",
    "type": "com.specsavers.rtp.catalog.talon-one.product.updated",
    "correlationid": "string",
    "data": {
      "assetKey": "string",
      "assetType": "product",
      "productTypeKey": "string",
      "productGroup": "frame",
      "isFromFullSync": true
    }
  }
  

  This example has been generated automatically.