Skip to main content

API Change Log - Rewards

Modules: Platform, Application

🧩 Service: Rewards​

🔧 Operation: showGiveaways​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.showGiveaways.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.showGiveaways.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ListGiveaway --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.showGiveaways.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.limit
  • New Schema:
{
  "type": "integer",
  "format": "int32",
  "description": "The maximum number of items to be returned per page.",
  "example": 10
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ListGiveaway --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.showGiveaways.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
  "type": "integer",
  "format": "int32",
  "description": "Total number of items.",
  "example": 1
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.showGiveaways.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/read"
    ]
  }
]

🔧 Operation: saveGiveAway​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.saveGiveAway.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.saveGiveAway.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.saveGiveAway.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.saveGiveAway.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.saveGiveAway.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/write"
    ]
  }
]

🔧 Operation: getGiveawayById​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGiveawayById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGiveawayById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getGiveawayById.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/read"
    ]
  }
]

🔧 Operation: updateGiveAway​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateGiveAway.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateGiveAway.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateGiveAway.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateGiveAway.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateGiveAway.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/write"
    ]
  }
]

🔧 Operation: showOffers​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.showOffers.methodTypePlaceHolder.responses.200.content.application/json.schema.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.showOffers.methodTypePlaceHolder.responses.200.content.application/json.schema.items.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.showOffers.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/read"
    ]
  }
]

🔧 Operation: getOfferByName​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getOfferByName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getOfferByName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getOfferByName.methodTypePlaceHolder.responses.500

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getOfferByName.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/read"
    ]
  }
]

🔧 Operation: updateOfferByName​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateOfferByName.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateOfferByName.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateOfferByName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateOfferByName.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateOfferByName.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/write"
    ]
  }
]

🔧 Operation: updateUserStatus​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateUserStatus.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateUserStatus.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateUserStatus.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/write"
    ]
  }
]

🔧 Operation: getUserDetails​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.user.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserDetails.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/read"
    ]
  }
]

🔧 Operation: getUserPointsHistory​

🔹 Change 1​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserPointsHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at.format
  • New Schema:
"date-time"

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserPointsHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updated_at.format
  • New Schema:
"date-time"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ListGiveaway --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserPointsHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.limit
  • New Schema:
{
  "type": "integer",
  "format": "int32",
  "description": "The maximum number of items to be returned per page.",
  "example": 10
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ListGiveaway --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getUserPointsHistory.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
  • New Schema:
{
  "type": "integer",
  "format": "int32",
  "description": "Total number of items.",
  "example": 1
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserPointsHistory.methodTypePlaceHolder.responses.500

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getUserPointsHistory.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/read"
    ]
  }
]

🔧 Operation: getRewardsConfiguration​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getRewardsConfiguration.methodTypePlaceHolder.responses.500

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getRewardsConfiguration.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/read"
    ]
  }
]

🔧 Operation: setRewardsConfiguration​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.setRewardsConfiguration.methodTypePlaceHolder.security
  • New Schema:
[
  {
    "oauth2": [
      "application/rewards/write"
    ]
  }
]

Was this section helpful?