EventCatalog

Properties

userId*:

The ID of the user whose points are about to expire.

email*:

The email of the user whose points are about to expire.

amount*:

records the number of points that are expiring.

expiresAt*:

records the date (yyyy-MM-dd) when the points will expire

rewardedAt*:

records the date (yyyy-MM-dd) when the points were received

currentPoints*:

recrods the total number of loyalty points a user has

duration*:

records after how many days will the points expire

id*:

The ID of the point that is going to expire within 3 days

flowchart LR l-Loyalty_Service[Loyalty Service]:::producer-->LoyaltyPointsExpiring[LoyaltyPointsExpiring]:::event classDef event stroke:#e569d9,stroke-width: 4px; classDef producer stroke:#75d7b6,stroke-width: 2px; classDef consumer stroke:#818cf8,stroke-width: 2px; LoyaltyPointsExpiring[LoyaltyPointsExpiring]:::event-->r-Analytics_Service[Analytics Service]:::consumer click l-Loyalty_Service href "/services/Loyalty Service" "Go to Loyalty Service" _self click r-Analytics_Service href "/services/Analytics Service" "Go to Analytics Service" _self click LoyaltyPointsExpiring href "/events/LoyaltyPointsExpiring" "Go to LoyaltyPointsExpiring" _self

LoyaltyPointsExpiring Schema (yml)

openapi: 3.0.0
info:
  version: "1.1.0"
  title: LoyaltyPointsExpiring
paths: {}
components:
  schemas:
    LoyaltyPointsExpiring:
      type: object
      required:
        - metadata
        - data
      properties:
        data:
          "$ref": "#/components/schemas/Data"
        metadata:
          "$ref": "#/components/schemas/Metadata"
    Data:
      type: object
      required:
        - userId
        - email
        - amount
        - expiresAt
        - rewardedAt
        - currentPoints
        - id

      properties:
        userId:
          type: string
        email:
          type: string
        amount:
          type: number
        expiresAt:
          type: string
          format: date #https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#data-types 
        rewardedAt:
          type: string
          format: date
        currentPoints:
          type: number
        duration:
          type: number
          enum:
            - 3
            - 30
        id:
          type: string

    Metadata:
      type: object
      required:
        - serviceFunction
        - version
      properties:
        serviceFunction:
          type: string
        version:
          type: string

LoyaltyPointsExpiringv1.1.0