Skip to main content

API Change Log - Share

🧩 Service: Share​

🔧 Operation: createShortLink​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createShortLink.methodTypePlaceHolder.parameters.0
  • New Schema:
{
  "$ref": "#/components/parameters/CompanyId"
}

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createShortLink.methodTypePlaceHolder.parameters.1
  • New Schema:
{
  "$ref": "#/components/parameters/ApplicationId"
}

🔹 Change 3​

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

🔹 Change 4​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkReq --> Redirects
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createShortLink.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.redirects.required

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkRes --> UrlInfo
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.createShortLink.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.url.properties.original

🔹 Change 6​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkRes --> UrlInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createShortLink.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.url.properties.alias
  • New Schema:
{
  "type": "string"
}

🔹 Change 7​

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

🔹 Change 8​

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

🔹 Change 9​

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

🔹 Change 10​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkReq --> Redirects
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createShortLink.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.redirects.required

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createShortLink.methodTypePlaceHolder.responses.400
  • New Schema:
{
  "description": "Error",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "examples": {
        "failure": {
          "value": {
            "message": "Something went wrong"
          }
        }
      }
    }
  }
}

🔹 Change 12​

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

🔹 Change 13​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createShortLink.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link"

🔹 Change 14​

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

🔧 Operation: getShortLinks​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getShortLinks.methodTypePlaceHolder.parameters.0
  • New Schema:
{
  "$ref": "#/components/parameters/CompanyId"
}

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getShortLinks.methodTypePlaceHolder.parameters.1
  • New Schema:
{
  "$ref": "#/components/parameters/ApplicationId"
}

🔹 Change 3​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getShortLinks.methodTypePlaceHolder.parameters.2
  • New Schema:
{
  "$ref": "#/components/parameters/PageNo"
}

🔹 Change 4​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getShortLinks.methodTypePlaceHolder.parameters.3
  • New Schema:
{
  "$ref": "#/components/parameters/PageSize"
}

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkRes --> UrlInfo
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getShortLinks.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.url.properties.original

🔹 Change 6​

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

🔹 Change 7​

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

🔹 Change 8​

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

🔹 Change 9​

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

🔹 Change 10​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkReq --> Redirects
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getShortLinks.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.redirects.required

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkList --> Page
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getShortLinks.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 12​

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

🔹 Change 13​

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

🔹 Change 14​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getShortLinks.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link"

🔹 Change 15​

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

🔧 Operation: getShortLinkByHash​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getShortLinkByHash.methodTypePlaceHolder.parameters.0.name
  • New Schema:
"hash"

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getShortLinkByHash.methodTypePlaceHolder.parameters.1
  • New Schema:
{
  "$ref": "#/components/parameters/CompanyId"
}

🔹 Change 3​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getShortLinkByHash.methodTypePlaceHolder.parameters.2
  • New Schema:
{
  "$ref": "#/components/parameters/ApplicationId"
}

🔹 Change 4​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkRes --> UrlInfo
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.getShortLinkByHash.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.url.properties.original

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkRes --> UrlInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.getShortLinkByHash.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.url.properties.alias
  • New Schema:
{
  "type": "string"
}

🔹 Change 6​

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

🔹 Change 7​

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

🔹 Change 8​

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

🔹 Change 9​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkReq --> Redirects
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getShortLinkByHash.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.redirects.required

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getShortLinkByHash.methodTypePlaceHolder.responses.404
  • New Schema:
{
  "description": "Error",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "examples": {
        "failure": {
          "value": {
            "message": "Something went wrong"
          }
        }
      }
    }
  }
}

🔹 Change 11​

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

🔹 Change 12​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getShortLinkByHash.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/{hash}"

🔹 Change 13​

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

🔧 Operation: updateShortLinkById​

🔹 Change 1​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateShortLinkById.methodTypePlaceHolder.parameters.0
  • New Schema:
{
  "$ref": "#/components/parameters/CompanyId"
}

🔹 Change 2​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateShortLinkById.methodTypePlaceHolder.parameters.1
  • New Schema:
{
  "$ref": "#/components/parameters/ApplicationId"
}

🔹 Change 3​

  • Action: replace
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateShortLinkById.methodTypePlaceHolder.parameters.2
  • New Schema:
{
  "$ref": "#/components/parameters/DocumentId"
}

🔹 Change 4​

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

🔹 Change 5​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkReq --> Redirects
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.updateShortLinkById.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.redirects.required

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkRes --> UrlInfo
  • Schema Action: PROPERTY_REMOVED
  • Path: paths.updateShortLinkById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.url.properties.original

🔹 Change 7​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkRes --> UrlInfo
  • Schema Action: PROPERTY_ADDED
  • Path: paths.updateShortLinkById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.url.properties.alias
  • New Schema:
{
  "type": "string"
}

🔹 Change 8​

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

🔹 Change 9​

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

🔹 Change 10​

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

🔹 Change 11​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: ShortLinkReq --> Redirects
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.updateShortLinkById.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.redirects.required

🔹 Change 12​

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

🔹 Change 13​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.updateShortLinkById.methodTypePlaceHolder.path
  • New Schema:
"/service/platform/share/v1.0/company/{company_id}/application/{application_id}/links/short-link/{id}"

🔹 Change 14​

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

🔧 Operation: getShortLinkClickStats​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.getShortLinkClickStats

Was this section helpful?