Search Event Definition 0.1.0 documentation

Search Event Definition 0.1.0

Operations

SEND api-ebb-{region}-integration-{env}

The application will send new operation notification messages through this channel.

Operation IDsend

object

env

required

string

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

"dev"
"qa"
"qa2"
"stg"
"prod"

Accepts one of the following messages:

application/json

Message IDSearchEventCategoryUpserted

Correlation ID$message.payload#/detail/correlationid

Default Correlation ID

The application will send category updated Search events through this channel.

object

#content

Examples

{
  "id": "string",
  "specversion": "1.0",
  "env": "dev",
  "sourceService": "com.specsavers/search-service",
  "type": "com.specsavers.rtp.search.category.upserted",
  "correlationid": "string",
  "data": {
    "assetKey": "string",
    "assetType": "category",
    "locales": {
      "property1": {
        "property1": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        },
        "property2": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        }
      },
      "property2": {
        "property1": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        },
        "property2": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        }
      }
    }
  }
}

This example has been generated automatically.

application/json

Message IDSearchEventCategoryDeleted

Correlation ID$message.payload#/detail/correlationid

Default Correlation ID

The application will send category deleted Search events through this channel.

object

#content

Examples

{
  "id": "string",
  "specversion": "1.0",
  "env": "dev",
  "sourceService": "com.specsavers/search-service",
  "type": "com.specsavers.rtp.search.category.deleted",
  "correlationid": "string",
  "data": {
    "assetKey": "string",
    "assetType": "category",
    "locales": {
      "property1": {
        "property1": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        },
        "property2": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        }
      },
      "property2": {
        "property1": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        },
        "property2": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        }
      }
    }
  }
}

This example has been generated automatically.

application/json

Message IDSearchEventProductUpserted

Correlation ID$message.payload#/detail/correlationid

Default Correlation ID

The application will send product updated Search events through this channel.

object

#content

Examples

{
  "id": "string",
  "specversion": "1.0",
  "env": "dev",
  "sourceService": "com.specsavers/search-service",
  "type": "com.specsavers.rtp.search.product.upserted",
  "correlationid": "string",
  "data": {
    "assetKey": "string",
    "assetType": "category",
    "locales": {
      "property1": {
        "property1": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        },
        "property2": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        }
      },
      "property2": {
        "property1": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        },
        "property2": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        }
      }
    }
  }
}

This example has been generated automatically.

application/json

Message IDSearchEventProductDeleted

Correlation ID$message.payload#/detail/correlationid

Default Correlation ID

The application will send product deleted Search events through this channel.

object

#content

Examples

{
  "id": "string",
  "specversion": "1.0",
  "env": "dev",
  "sourceService": "com.specsavers/search-service",
  "type": "com.specsavers.rtp.search.product.deleted",
  "correlationid": "string",
  "data": {
    "assetKey": "string",
    "assetType": "category",
    "locales": {
      "property1": {
        "property1": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        },
        "property2": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        }
      },
      "property2": {
        "property1": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        },
        "property2": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        }
      }
    }
  }
}

This example has been generated automatically.

application/json

Message IDSearchEventPageUpserted

Correlation ID$message.payload#/detail/correlationid

Default Correlation ID

The application will send product updated Search events through this channel.

object

#content

Examples

{
  "id": "string",
  "specversion": "1.0",
  "env": "dev",
  "sourceService": "com.specsavers/search-service",
  "type": "com.specsavers.rtp.search.page.upserted",
  "correlationid": "string",
  "data": {
    "assetKey": "string",
    "assetType": "brand-page",
    "locales": {
      "property1": {
        "property1": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        },
        "property2": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        }
      },
      "property2": {
        "property1": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        },
        "property2": {
          "existingUrl": "string",
          "newUrl": "string",
          "wasArchived": true,
          "colors": {
            "property1": "string",
            "property2": "string"
          }
        }
      }
    }
  }
}

This example has been generated automatically.

Schemas

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

Allowed values:
"dev"
"qa"
"qa2"
"stg"
"prod"
SearchEventSource
string
Const:"com.specsavers/search-service"
SearchEventCommerceAssetType
string
Allowed values:
"category"
"product"
"lens-options"
SearchEventPageAssetType
string
Allowed values:
"brand-page"
"category-page"
"collection-page"
"content-page"
"health-page"
"health-fund-page"
"home-page"
"offer-page"
"faq-details"
object
assetKey
required
string
assetType
string
Allowed values:
"brand-page"
"category-page"
"collection-page"
"content-page"
"health-page"
"health-fund-page"
"home-page"
"offer-page"
"faq-details"
required
object
object
object
existingUrl
string
newUrl
string
wasArchived
boolean
object
Additional properties:
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
object
assetKey
required
string
assetType
required
string
Allowed values:
"category"
"product"
"lens-options"
required
object
object
object
existingUrl
string
newUrl
string
wasArchived
boolean
object
Additional properties:
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
object
existingUrl
string
newUrl
string
wasArchived
boolean
object
Additional properties:
string
Additional properties are NOT allowed.
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/search-service"
type
required
string
Const:"com.specsavers.rtp.search.category.upserted"
correlationid
required
string
The correlation ID of the event. E.g. 1234

required
object
assetKey
required
string
assetType
required
string
Allowed values:
"category"
"product"
"lens-options"
required
object
object
object
existingUrl
string
newUrl
string
wasArchived
boolean
object
Additional properties:
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
x-envelope-type
cloudevent
Additional properties are allowed.
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/search-service"
type
required
string
Const:"com.specsavers.rtp.search.category.deleted"
correlationid
required
string
The correlation ID of the event. E.g. 1234

required
object
assetKey
required
string
assetType
required
string
Allowed values:
"category"
"product"
"lens-options"
required
object
object
object
existingUrl
string
newUrl
string
wasArchived
boolean
object
Additional properties:
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
x-envelope-type
cloudevent
Additional properties are allowed.
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/search-service"
type
required
string
Const:"com.specsavers.rtp.search.product.upserted"
correlationid
required
string
The correlation ID of the event. E.g. 1234

required
object
assetKey
required
string
assetType
required
string
Allowed values:
"category"
"product"
"lens-options"
required
object
object
object
existingUrl
string
newUrl
string
wasArchived
boolean
object
Additional properties:
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
x-envelope-type
cloudevent
Additional properties are allowed.
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/search-service"
type
required
string
Const:"com.specsavers.rtp.search.product.deleted"
correlationid
required
string
The correlation ID of the event. E.g. 1234

required
object
assetKey
required
string
assetType
required
string
Allowed values:
"category"
"product"
"lens-options"
required
object
object
object
existingUrl
string
newUrl
string
wasArchived
boolean
object
Additional properties:
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
x-envelope-type
cloudevent
Additional properties are allowed.
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/search-service"
type
required
string
Const:"com.specsavers.rtp.search.page.upserted"
correlationid
required
string
The correlation ID of the event. E.g. 1234

required
object
assetKey
required
string
assetType
string
Allowed values:
"brand-page"
"category-page"
"collection-page"
"content-page"
"health-page"
"health-fund-page"
"home-page"
"offer-page"
"faq-details"
required
object
object
object
existingUrl
string
newUrl
string
wasArchived
boolean
object
Additional properties:
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
x-envelope-type
cloudevent
Additional properties are allowed.