Modules: Platform, Admin, Application
🧩 Service: Catalog​
🔧 Operation: getCatalogInsights​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCatalogInsights.methodTypePlaceHolder.responses.4XX
🔹 Change 2​
- Action:
replace - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCatalogInsights.methodTypePlaceHolder.path - New Schema:
"/service/platform/catalog/v1.0/company/{company_id}/application/{application_id}/analytics/insights"
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getCatalogInsights.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/products/read"
]
}
]
🔧 Operation: getApplicationBrandListing​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
ApplicationBrandListingSchema --> ApplicationBrandListingItemSchema - Schema Action:
PROPERTY_REMOVED - Path:
paths.getApplicationBrandListing.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.modified_on
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ApplicationBrandListingSchema --> Page - Schema Action:
PROPERTY_ADDED - Path:
paths.getApplicationBrandListing.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 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ApplicationBrandListingSchema --> Page - Schema Action:
PROPERTY_ADDED - Path:
paths.getApplicationBrandListing.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 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ApplicationBrandListingSchema - Schema Action:
REQUIRED_ADDED - Path:
paths.getApplicationBrandListing.methodTypePlaceHolder.responses.200.content.application/json.schema.required - New Schema:
[
"page"
]
🔹 Change 5​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
ApplicationBrandListingSchema - Schema Action:
DATA_TYPE_ADDED - Path:
paths.getApplicationBrandListing.methodTypePlaceHolder.responses.200.content.application/json.schema.type - New Schema:
"object"
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getApplicationBrandListing.methodTypePlaceHolder.responses.400 - New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid request",
"errors": {
"page_size": [
"Must be greater than or equal to 1."
]
}
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
🔹 Change 7​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getApplicationBrandListing.methodTypePlaceHolder.responses.4XX
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getApplicationBrandListing.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]
🔧 Operation: updateAppBrand​
🔹 Change 1​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.updateAppBrand.methodTypePlaceHolder.parameters.0.schema.type - New Schema:
"integer"
🔹 Change 2​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
ApplicationBrandJson - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.updateAppBrand.methodTypePlaceHolder.requestBody.content.application/json.schema.properties._custom_json.additionalProperties - New Schema:
true
🔹 Change 3​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
ApplicationBrandJson - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.updateAppBrand.methodTypePlaceHolder.requestBody.content.application/json.schema.additionalProperties - New Schema:
true
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateAppBrand.methodTypePlaceHolder.responses.400 - New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Invalid Brand : 99 for Company : 99"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
🔹 Change 5​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateAppBrand.methodTypePlaceHolder.responses.4XX
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.updateAppBrand.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"company/brands/write"
]
}
]
🔧 Operation: getApplicationBrands​
🔹 Change 1​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.getApplicationBrands.methodTypePlaceHolder.parameters.0.schema.type - New Schema:
"integer"
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> Action --> ActionPage --> PageType - Schema Action:
ENUM_VALUE_ADDED - Path:
paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.action.properties.page.properties.type.enum.48 - New Schema:
"internl"
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> Action --> ActionPage - Schema Action:
PROPERTY_ADDED - Path:
paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.action.properties.page.properties.value - New Schema:
{
"type": "string",
"description": "The value for the action."
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> Action --> ActionPage --> PageType - Schema Action:
ENUM_VALUE_ADDED - Path:
paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.action.properties.popup.properties.type.enum.48 - New Schema:
"internl"
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> Action --> ActionPage - Schema Action:
PROPERTY_ADDED - Path:
paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.action.properties.popup.properties.value - New Schema:
{
"type": "string",
"description": "The value for the action."
}
🔹 Change 6​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.departments.items.type - New Schema:
"integer"
🔹 Change 7​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
BrandListingResponse --> BrandItem --> BrandMedia - Schema Action:
PROPERTY_REMOVED - Path:
paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.logo.properties.aspect_ratio
🔹 Change 8​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> BrandLogo - Schema Action:
DATA_TYPE_ADDED - Path:
paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.logo.type - New Schema:
"object"
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ApplicationBrandListingSchema --> Page - Schema Action:
PROPERTY_ADDED - Path:
paths.getApplicationBrands.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 10​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
ApplicationBrandListingSchema --> Page - Schema Action:
PROPERTY_ADDED - Path:
paths.getApplicationBrands.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 11​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema - Schema Action:
PROPERTY_ADDED - Path:
paths.getApplicationBrands.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.modified_on - New Schema:
{
"type": "string",
"format": "date-time",
"description": "Timestamp when the brand was last modified."
}
🔹 Change 12​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getApplicationBrands.methodTypePlaceHolder.responses.400 - New Schema:
{
"content": {
"application/json": {
"examples": {
"failure": {
"value": {
"code": 400,
"message": "Department not Found"
}
}
},
"schema": {
"$ref": "#/components/schemas/ErrorResponseSchema"
}
}
},
"description": "Bad request. See the error object in the response body for specific reason"
}
🔹 Change 13​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getApplicationBrands.methodTypePlaceHolder.responses.4XX
🔹 Change 14​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getApplicationBrands.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"application/settings/read"
]
}
]
🔧 Operation: getCategories​
🔹 Change 1​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.getCategories.methodTypePlaceHolder.parameters.0.schema.type - New Schema:
"integer"
🔹 Change 2​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> Action --> ActionPage --> PageType - Schema Action:
ENUM_VALUE_ADDED - Path:
paths.getCategories.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.items.items.properties.action.properties.page.properties.type.enum.48 - New Schema:
"internl"
🔹 Change 3​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> Action --> ActionPage - Schema Action:
PROPERTY_ADDED - Path:
paths.getCategories.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.items.items.properties.action.properties.page.properties.value - New Schema:
{
"type": "string",
"description": "The value for the action."
}
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> Action --> ActionPage --> PageType - Schema Action:
ENUM_VALUE_ADDED - Path:
paths.getCategories.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.items.items.properties.action.properties.popup.properties.type.enum.48 - New Schema:
"internl"
🔹 Change 5​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> Action --> ActionPage - Schema Action:
PROPERTY_ADDED - Path:
paths.getCategories.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.items.items.properties.action.properties.popup.properties.value - New Schema:
{
"type": "string",
"description": "The value for the action."
}
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> Action --> ActionPage --> PageType - Schema Action:
ENUM_VALUE_ADDED - Path:
paths.getCategories.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.items.items.properties.childs.items.properties.action.properties.page.properties.type.enum.48 - New Schema:
"internl"
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
BrandListingResponseSchema --> BrandItem --> Action --> ActionPage - Schema Action:
PROPERTY_ADDED - Path:
paths.getCategories.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.items.items.properties.childs.items.properties.action.properties.page.properties.value - New Schema:
{
"type": "string",
"description": "The value for the action."
}