API Change Log - Configuration

🧩 Service: Configuration

🔧 Operation: searchApplication

🔹 Change 1

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

"date-time"

🔹 Change 2

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: ApplicationResponse --> Application
• Schema Action: PROPERTY_REMOVED
• Path: paths.searchApplication.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application.properties.updated_at

🔹 Change 3

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ApplicationResponseSchema --> Application --> Domain
• Schema Action: PROPERTY_ADDED
• Path: paths.searchApplication.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application.properties.domains.items.properties.display_name
• New Schema:

{
  "type": "string"
}

🔹 Change 4

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ApplicationResponseSchema --> Application --> Domain
• Schema Action: PROPERTY_ADDED
• Path: paths.searchApplication.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application.properties.domain.properties.display_name
• New Schema:

{
  "type": "string"
}

🔹 Change 5

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ApplicationResponseSchema --> Application
• Schema Action: PROPERTY_ADDED
• Path: paths.searchApplication.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application.properties.modified_at
• New Schema:

{
  "type": "string",
  "description": "ISO 8601 timestamp of sales channel updation",
  "format": "date-time"
}

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ApplicationResponseSchema --> Application
• Schema Action: PROPERTY_ADDED
• Path: paths.searchApplication.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application.properties.mode
• New Schema:

{
  "type": "string"
}

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ApplicationResponseSchema --> Application
• Schema Action: PROPERTY_ADDED
• Path: paths.searchApplication.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application.properties.status
• New Schema:

{
  "type": "string"
}

🔹 Change 8

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: ApplicationResponseSchema --> Application
• Schema Action: PROPERTY_ADDED
• Path: paths.searchApplication.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application.properties.tokens
• New Schema:

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TokenSchema"
  }
}

🔹 Change 9

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

🔹 Change 10

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

🔹 Change 11

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

"/service/public/configuration/v1.0/application/search-application"

🔧 Operation: getLocations

🔹 Change 1

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

"/service/public/configuration/v1.0/location"

🔧 Operation: checkVersionIsUpToDate

🔹 Change 1

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

{
  "methodTypePlaceHolder": {
    "summary": "Check application version",
    "description": "Check if the application version is up to date.",
    "operationId": "checkVersionIsUpToDate",
    "tags": [
      "Common"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VersionRequestSchema"
          },
          "examples": {
            "success": {
              "value": {
                "application": {
                  "name": "fynd_platform_seller_ios",
                  "version": "0.2.20"
                },
                "device": {
                  "os": {
                    "name": "ios"
                  }
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successful response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/VersionResponseSchema"
            },
            "examples": {
              "success": {
                "value": {
                  "type": "UP_TO_DATE",
                  "title": "Up To Date",
                  "description": "The application is up to date",
                  "update_dialog": {
                    "type": "INTERVAL",
                    "interval": 10080
                  },
                  "is_app_blocked": false
                }
              }
            }
          }
        }
      }
    },
    "x-groups": [
      "Application Information"
    ],
    "path": "/service/public/configuration/v1.0/version",
    "methodType": "post"
  }
}