API Change Log - Content

🧩 Service: Content

🔧 Operation: getCredentialsByEntity

🔹 Change 1

• Action: replace
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getCredentialsByEntity.methodTypePlaceHolder.parameters.0
• New Schema:

{
  "$ref": "#/components/parameters/entityType"
}

🔹 Change 2

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getCredentialsByEntity.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.configuration.properties
• New Schema:

{
  "token": {
    "type": "string"
  },
  "host": {
    "type": "string"
  }
}

🔹 Change 3

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: CredentialsSchema --> CredentialSchema
• Schema Action: ENUM_ADDED
• Path: paths.getCredentialsByEntity.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.entity_type.enum
• New Schema:

[
  "platform",
  "partner"
]

🔹 Change 4

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: CredentialsSchema --> CredentialSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.getCredentialsByEntity.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._id
• New Schema:

{
  "type": "string"
}

🔹 Change 5

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: CredentialsSchema --> CredentialSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.getCredentialsByEntity.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updated_at
• New Schema:

{
  "type": "string",
  "format": "date-time"
}

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: CredentialsSchema --> CredentialSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.getCredentialsByEntity.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at
• New Schema:

{
  "type": "string",
  "format": "date-time"
}

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: CredentialsSchema --> CredentialSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.getCredentialsByEntity.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.__v
• New Schema:

{
  "type": "number"
}

🔹 Change 8

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getCredentialsByEntity.methodTypePlaceHolder.responses.4XX

🔹 Change 9

• Action: replace
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getCredentialsByEntity.methodTypePlaceHolder.path
• New Schema:

"/service/public/content/credentials/{entity_type}"

🔧 Operation: getBasicDetails

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getBasicDetails
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "get basic platform information",
    "description": "get basic platform information on Admin panel like Common Settings, Appereance of  Authentication Page, Text on Seller Login or Register Page, Business Account Restrictions, Seller Support Details and Footer Details",
    "tags": [
      "Basic Details"
    ],
    "operationId": "getBasicDetails",
    "responses": {
      "200": {
        "description": "Success.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/BasicDetailsPayloadSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/BasicDetailsPayloadExample"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Basic Details Management"
    ],
    "path": "/service/public/content/basic-details",
    "methodType": "get"
  }
}

🔧 Operation: getMenuContent

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getMenuContent
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get desktop menu content",
    "description": "Retrieves the desktop menu content.",
    "tags": [
      "Menu"
    ],
    "operationId": "getMenuContent",
    "responses": {
      "200": {
        "description": "Successful response with menu content",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/MenusSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/MenusExample"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Menu Management"
    ],
    "path": "/service/public/content/menu",
    "methodType": "get"
  }
}

🔧 Operation: getMenuContentByType

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getMenuContentByType
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get desktop menu content",
    "description": "Retrieves the desktop menu content.",
    "tags": [
      "Menu"
    ],
    "operationId": "getMenuContentByType",
    "parameters": [
      {
        "$ref": "#/components/parameters/menuType"
      }
    ],
    "responses": {
      "200": {
        "description": "Successful response with menu content by type",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/MenuTypeSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/MenuTypeExample"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Menu Management"
    ],
    "path": "/service/public/content/menu/{type}",
    "methodType": "get"
  }
}

🔧 Operation: getAnalyticsTags

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getAnalyticsTags
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Analytics Tags",
    "description": "Retrieve analytics tags.",
    "tags": [
      "Content"
    ],
    "operationId": "getAnalyticsTags",
    "responses": {
      "200": {
        "description": "Successful response with analytics tags.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AnalyticsTagsSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/AnalyticsTagsExample"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Analytics Tags Management"
    ],
    "path": "/service/public/content/analytics-tags",
    "methodType": "get"
  }
}

🔧 Operation: getCustomPage

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getCustomPage
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Retrieve info for custom page.",
    "description": "Retrieve info of custom pagee to develop and manage custom webpages.",
    "tags": [
      "Custom Page"
    ],
    "operationId": "getCustomPage",
    "parameters": [
      {
        "$ref": "#/components/parameters/slug"
      }
    ],
    "responses": {
      "200": {
        "description": "Retrieve info of custom pagee to develop and manage custom webpages.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CustomPageBySlugSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/CustomPageBySlugExample"
              }
            }
          }
        }
      },
      "404": {
        "description": "Internal Server Error. See the error object in the response body to know the exact reason.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ContentAPIError"
            },
            "examples": {
              "failure": {
                "$ref": "#/components/examples/4XXAPIError"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Custom Page Management"
    ],
    "path": "/service/public/content/custom-pages/{slug}",
    "methodType": "get"
  }
}

🔧 Operation: getFooterContent

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getFooterContent
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Footer Content",
    "description": "Retrieve footer content.",
    "tags": [
      "Content"
    ],
    "operationId": "getFooterContent",
    "responses": {
      "200": {
        "description": "Successful response with footer content.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/FooterSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/FooterExample"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Footer Content Management"
    ],
    "path": "/service/public/content/footer",
    "methodType": "get"
  }
}

🔧 Operation: getHomePageContent

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getHomePageContent
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Home Page Content",
    "description": "Retrieve home page content for a specific page type.",
    "tags": [
      "Content"
    ],
    "operationId": "getHomePageContent",
    "parameters": [
      {
        "$ref": "#/components/parameters/pageType"
      }
    ],
    "responses": {
      "200": {
        "description": "Successful response with home page content.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/HomePageContentSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/HomePageContentExample"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Home Page Management"
    ],
    "path": "/service/public/content/home-page",
    "methodType": "get"
  }
}

🔧 Operation: getNavbar

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getNavbar
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Navbar",
    "description": "Retrieve navbar information.",
    "tags": [
      "Navbar"
    ],
    "operationId": "getNavbar",
    "responses": {
      "200": {
        "description": "Successful response with navbar information.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/NavbarSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/NavbarExample"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Navbar Management"
    ],
    "path": "/service/public/content/navbar",
    "methodType": "get"
  }
}

🔧 Operation: getPricingBanner

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getPricingBanner
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Pricing Banner",
    "description": "Retrieve pricing banner information.",
    "tags": [
      "Pricing Banner"
    ],
    "operationId": "getPricingBanner",
    "responses": {
      "200": {
        "description": "Successful response with pricing banner information.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/PricingBannerSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/PricingBannerExample"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Pricing Banner Management"
    ],
    "path": "/service/public/content/pricing-banner",
    "methodType": "get"
  }
}

🔧 Operation: getAllTags

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getAllTags
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Retrieve tags with injected css/javascript info.",
    "description": "Retrieve custom tag with injected css/javascript info.",
    "tags": [
      "Tags"
    ],
    "operationId": "getAllTags",
    "responses": {
      "200": {
        "description": "Retrieve all tags with injected css/javascript info.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/TagsSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/TagsSchemaExample"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Tags Management"
    ],
    "path": "/service/public/content/tags",
    "methodType": "get"
  }
}

🔧 Operation: getSDKDocumentation

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getSDKDocumentation
• New Schema:

{
  "methodTypePlaceHolder": {
    "description": "Get documentation of SDK",
    "summary": "Get documentation link of Software Development Kit",
    "operationId": "getSDKDocumentation",
    "responses": {
      "200": {
        "description": "Success. Refer `SDKLinksResponseSchema` for more details.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SDKLinksResponseSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/SDKLinksResponseExample"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "SDK Documentation"
    ],
    "path": "/service/public/content/sdk-readme",
    "methodType": "get"
  }
}

🔧 Operation: getSDKDocumentationByType

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getSDKDocumentationByType
• New Schema:

{
  "methodTypePlaceHolder": {
    "description": "Get documentation of SDK by its type",
    "summary": "Get documentation of Software Development Kit by its type",
    "operationId": "getSDKDocumentationByType",
    "parameters": [
      {
        "$ref": "#/components/parameters/SDKType"
      }
    ],
    "responses": {
      "200": {
        "description": "Success. Refer `SDKbyTypeResponseSchema` for more details.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SDKbyTypeResponseSchema"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/SDKByTypeResponse"
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "SDK Documentation"
    ],
    "path": "/service/public/content/sdk-readme/{type}",
    "methodType": "get"
  }
}