Skip to main content

API Change Log - FileStorage

🧩 Service: FileStorage​

🔧 Operation: startUpload​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: StartResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.startUpload.methodTypePlaceHolder.responses.200.content.application/json.schema.required.7

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: StartResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.startUpload.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cdn

🔹 Change 3​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.startUpload.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/assets/v2.0/company/{company_id}/namespaces/{namespace}/upload/start"

🔹 Change 4​

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

🔧 Operation: completeUpload​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: StartResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.completeUpload.methodTypePlaceHolder.requestBody.content.application/json.schema.required.7

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: StartResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.completeUpload.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.cdn

🔹 Change 3​

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

🔹 Change 4​

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

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: FileUploadComplete --> CreatedBy
  • Schema Action: PROPERTY_ADDED
  • Path: paths.completeUpload.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_by.properties.user_id
  • New Schema:
{
  "type": "string",
  "description": "The unique identifier of the user."
}

🔹 Change 6​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.completeUpload.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/assets/v2.0/company/{company_id}/namespaces/{namespace}/upload/complete"

🔹 Change 7​

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

🔧 Operation: appStartUpload​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: StartResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.appStartUpload.methodTypePlaceHolder.responses.200.content.application/json.schema.required.7

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: StartResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.appStartUpload.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.cdn

🔹 Change 3​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.appStartUpload.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/assets/v2.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/start"

🔹 Change 4​

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

🔧 Operation: appCompleteUpload​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: StartResponse
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.appCompleteUpload.methodTypePlaceHolder.requestBody.content.application/json.schema.required.7

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: StartResponse
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.appCompleteUpload.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.cdn

🔹 Change 3​

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

🔹 Change 4​

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

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: FileUploadComplete --> CreatedBy
  • Schema Action: PROPERTY_ADDED
  • Path: paths.appCompleteUpload.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_by.properties.user_id
  • New Schema:
{
  "type": "string",
  "description": "The unique identifier of the user."
}

🔹 Change 6​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.appCompleteUpload.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/assets/v2.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/complete"

🔹 Change 7​

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

🔧 Operation: getSignUrls​

🔹 Change 1​

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

🔧 Operation: copyFiles​

🔹 Change 1​

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

🔧 Operation: appCopyFiles​

🔹 Change 1​

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

🔧 Operation: browse​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.browse.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_by.properties.user_id
  • New Schema:
{
  "type": "string"
}

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.browse.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.createdAt

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.browse.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updatedAt

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.browse.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at
  • New Schema:
{
  "type": "string"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.browse.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updated_at
  • New Schema:
{
  "type": "string"
}

🔹 Change 6​

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

🔧 Operation: appbrowse​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.appbrowse.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_by.properties.user_id
  • New Schema:
{
  "type": "string"
}

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.appbrowse.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.createdAt

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.appbrowse.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updatedAt

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.appbrowse.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at
  • New Schema:
{
  "type": "string"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.appbrowse.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updated_at
  • New Schema:
{
  "type": "string"
}

🔹 Change 6​

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

🔧 Operation: browsefiles​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.browsefiles.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_by.properties.user_id
  • New Schema:
{
  "type": "string"
}

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.browsefiles.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.createdAt

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.browsefiles.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updatedAt

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.browsefiles.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at
  • New Schema:
{
  "type": "string"
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: PROPERTY_ADDED
  • Path: paths.browsefiles.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updated_at
  • New Schema:
{
  "type": "string"
}

🔹 Change 6​

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

🔧 Operation: getPdfTypes​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getPdfTypes.methodTypePlaceHolder.parameters.3
  • New Schema:
{
  "$ref": "#/components/parameters/StoreOs"
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: InvoiceTypes --> InvoiceTypesData
  • Schema Action: REQUIRED_FIELD_ADDED
  • Path: paths.getPdfTypes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.required.7
  • New Schema:
"store_os"

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: InvoiceTypes --> InvoiceTypesData
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getPdfTypes.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.store_os
  • New Schema:
{
  "type": "boolean",
  "description": "Specifies whether the invoice type is store-OS enabled."
}

🔹 Change 4​

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

🔧 Operation: getDefaultPdfData​

🔹 Change 1​

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

🔹 Change 2​

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

🔹 Change 3​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: DummyTemplateDataItems --> DummyTemplateData --> DummyTemplateDataPayload --> ProductTable --> ItemsProductTable
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getDefaultPdfData.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.payload.properties.product_table.properties.products.items.properties.trader_information

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: DummyTemplateDataItems --> DummyTemplateData --> DummyTemplateDataPayload
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getDefaultPdfData.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.payload.properties.shipment_meta

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: DummyTemplateDataItems --> DummyTemplateData --> DummyTemplateDataPayload
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getDefaultPdfData.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.payload.properties.order_meta

🔹 Change 6​

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

🔧 Operation: updateHtmlTemplate​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PdfConfig
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateHtmlTemplate.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.country_code
  • New Schema:
{
  "type": "string",
  "x-not-enum": true,
  "description": "Country code associated with the configuration."
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PdfConfig
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateHtmlTemplate.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.default_template
  • New Schema:
{
  "type": "boolean",
  "description": "Indicates whether the fetched template is the default template."
}

🔹 Change 3​

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

🔹 Change 4​

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

🔧 Operation: ::action:-:OPERATION_ID_UPDATED::​

🔹 Change 1​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PdfConfig
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.saveHtmlTemplate.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.country_code
  • New Schema:
{
  "type": "string",
  "x-not-enum": true,
  "description": "Country code associated with the configuration."
}

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: PdfConfig
  • Schema Action: PROPERTY_ADDED
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.saveHtmlTemplate.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.default_template
  • New Schema:
{
  "type": "boolean",
  "description": "Indicates whether the fetched template is the default template."
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.fetchPdfTypeById
  • New Schema:
{
  "methodTypePlaceHolder": {
    "summary": "Get the pdf types of by id",
    "description": "Get the pdf types of PDF formats for filter",
    "operationId": "fetchPdfTypeById",
    "tags": [
      "PDF"
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/CompanyId"
      },
      {
        "$ref": "#/components/parameters/ApplicationId"
      },
      {
        "$ref": "#/components/parameters/PdfTypeMongoId"
      }
    ],
    "responses": {
      "200": {
        "description": "Get Pdf types successfully for given id.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/PdfTypeByIdDetails"
            },
            "examples": {
              "success": {
                "value": {
                  "store_os": false,
                  "_id": "65ca228e6b701f6e108ba690",
                  "country_code": "IN",
                  "pdf_type_id": 96,
                  "__v": 0,
                  "format": [
                    "A4",
                    "A6",
                    "POS"
                  ],
                  "name": "invoice_get",
                  "visibility": false
                }
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "application/assets/read"
        ]
      }
    ],
    "x-groups": [
      "Invoice Templates"
    ],
    "path": "/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/types/{id}",
    "methodType": "get"
  }
}

🔹 Change 4​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getPdfPayloadById
  • New Schema:
{
  "methodTypePlaceHolder": {
    "summary": "Get default PDF data.",
    "description": "Retrieve default data for PDF generation.",
    "operationId": "getPdfPayloadById",
    "tags": [
      "PDF"
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/CompanyId"
      },
      {
        "$ref": "#/components/parameters/ApplicationId"
      },
      {
        "$ref": "#/components/parameters/pdfPyloadId"
      }
    ],
    "responses": {
      "200": {
        "description": "Get dummy json data for invoice",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/MapperDetails"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/PdfPayloadExample"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "application/assets/read"
        ]
      }
    ],
    "x-groups": [
      "Invoice Templates"
    ],
    "path": "/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/mapper/{id}",
    "methodType": "get"
  }
}

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.getConfigHtmlTemplateById
  • New Schema:
{
  "methodTypePlaceHolder": {
    "summary": "Update html template for invoice or label",
    "description": "Update html template for invoice such as Invoice, Label, Deliver challan",
    "operationId": "getConfigHtmlTemplateById",
    "tags": [
      "PDF"
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/CompanyId"
      },
      {
        "$ref": "#/components/parameters/ApplicationId"
      },
      {
        "$ref": "#/components/parameters/getConfig"
      }
    ],
    "responses": {
      "200": {
        "description": "Update html template for invoice",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "_id": {
                  "type": "string"
                },
                "application_id": {
                  "type": "string"
                },
                "company_id": {
                  "type": "integer"
                },
                "format": {
                  "type": "string"
                },
                "pdf_type_id": {
                  "type": "integer"
                },
                "__v": {
                  "type": "integer"
                },
                "created_at": {
                  "type": "string",
                  "format": "date-time"
                },
                "template": {
                  "type": "string"
                },
                "updated_at": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            "examples": {
              "success": {
                "value": {
                  "_id": "65ccd7250ffb27e1f347e22a",
                  "application_id": "5da1aa89e9b4036afd623686",
                  "company_id": 568,
                  "format": "A4",
                  "pdf_type_id": 1,
                  "__v": 0,
                  "created_at": "2024-02-12T13:52:16.985Z",
                  "template": "<div>\n  \n</div>",
                  "updated_at": "2024-02-15T07:43:40.993Z"
                }
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "application/assets/read"
        ]
      }
    ],
    "x-groups": [
      "Invoice Templates"
    ],
    "path": "/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/config/{id}",
    "methodType": "get"
  }
}

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.deletePdfGeneratorConfig
  • New Schema:
{
  "methodTypePlaceHolder": {
    "summary": "Delete a PDF generator configuration",
    "description": "Deletes a specific PDF generator configuration based on the provided id.",
    "operationId": "deletePdfGeneratorConfig",
    "tags": [
      "PDF"
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/CompanyId"
      },
      {
        "$ref": "#/components/parameters/ApplicationId"
      },
      {
        "$ref": "#/components/parameters/Id"
      }
    ],
    "responses": {
      "200": {
        "description": "Successful deletion of the PDF generator configuration.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "success": {
                  "type": "boolean",
                  "description": "Indicates if the deletion was successful."
                }
              }
            },
            "examples": {
              "success": {
                "value": {
                  "success": true
                }
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "application/assets/write"
        ]
      }
    ],
    "x-groups": [
      "Invoice Templates"
    ],
    "path": "/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/config/{id}",
    "methodType": "delete"
  }
}

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.fetchPdfDefaultTemplateById
  • New Schema:
{
  "methodTypePlaceHolder": {
    "summary": "get default html template for invoice or label",
    "description": "get default html template for invoice such as Invoice, Label, Deliver challan",
    "operationId": "fetchPdfDefaultTemplateById",
    "tags": [
      "PDF"
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/CompanyId"
      },
      {
        "$ref": "#/components/parameters/ApplicationId"
      },
      {
        "$ref": "#/components/parameters/PdfDefaultTemplateId"
      }
    ],
    "responses": {
      "200": {
        "description": "Update html template for invoice",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/PdfDefaultTemplateById"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/PdfDefaultTemplateResponseExample"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "application/assets/read"
        ]
      }
    ],
    "x-groups": [
      "Invoice Templates"
    ],
    "path": "/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/pdf/default-template/{id}",
    "methodType": "get"
  }
}

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.::action:-:OPERATION_ID_UPDATED::.proxy
  • New Schema:
{
  "methodTypePlaceHolder": {
    "summary": "Proxy file access.",
    "description": "Access files through a proxy.",
    "operationId": "proxy",
    "tags": [
      "FileStorage"
    ],
    "parameters": [
      {
        "$ref": "#/components/parameters/CompanyId"
      },
      {
        "name": "url",
        "in": "query",
        "description": "url",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "https://reqres.in/api/users/2"
          },
          "failure": {
            "value": "platform/pictures/free-logo/original/7qdHNTFe--platform-logo.png"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Success",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ProxyFileAccess"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/ProxyResponseExample"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/assets/read"
        ]
      }
    ],
    "x-groups": [
      "Proxy"
    ],
    "path": "/service/platform/assets/v1.0/company/{company_id}/proxy",
    "methodType": "get"
  }
}

Was this section helpful?