Copy single page API with custom body does not work anymore

Confluence Development Confluence Cloud
1

We are experiencing a major problem with the Copy single page API. One of the core features of our app (Scroll Documents) is to create copies of pages (or rather page trees) where include macros are resolved, so the macros are replaced by the actual content of the included page, and any attachments referenced by the included page are copied over.

Imagine you have a Page A and a Page B. Page A contains an include macro that includes page B. Now you want to create a copy of Page A (called Page A*) where the include macro is resolved. The way our app does this is:

  1. Fetch Page A, parse the storage format and look for include macros
  2. Discover the include macro pointing to Page B, so fetch Page B and replace the macro with the body of page B in the parsed body of Page A
  3. Now copy Page A to Page A* by using the Copy single page API (using a parent_page destination). Specify the parsed body of Page A with the replaced include macro as a custom body during the copy operation.
  4. Look at the body of Page B and see if it references any attachments attached to itself. If it does, use the Copy single page API with an existing_page target to copy Page B to Page A*, with copyAttachments: true and specifying the body of Page A* as a custom body for the copy operation. This will copy all attachments of Page B to Page A* (which is needed because they are referenced in the included content), without changing the body of Page A*.

While this definitely worked back when I was developing this feature, we just discovered by accident that step 3 doesn’t work anymore as intended. I don’t know for how long this has been the case, but I hope for not too long, because this breaks one of the core features of our app without being immediately noticeable (because include macros are not identifiable when viewing the page).

What seems to happen is that in step 3, when specifying a custom body using a parent_page copy destination, that custom body is ignored the the body of the target page is the same as the body of the source page. However, in step 4, when specifying a custom body using an existing_page copy destination, specifying the custom body seems to work.

For reference, here are the two exact requests that we are doing:

POST https://cdauth.atlassian.net/wiki/rest/api/content/1182859265/copy?expand=children.attachment.version%2Cbody.storage%2Cmetadata.properties.K15tDocsPage%2Cversion%2Cspace

{
  "copyAttachments" : true,
  "copyPermissions" : false,
  "copyProperties" : false,
  "copyLabels" : true,
  "copyCustomContents" : false,
  "destination" : {
    "type" : "parent_page",
    "value" : "1185349633"
  },
  "pageTitle" : "(v24) Include test",
  "body" : {
    "storage" : {
      "value" : "<p>Test content 1</p>",
      "representation" : "storage"
    },
    "raw" : null
  }
}

POST https://cdauth.atlassian.net/wiki/rest/api/content/1179582465/copy?expand=children.attachment.version%2Cbody.storage%2Cmetadata.properties.K15tDocsPage%2Cversion%2Cspace

{
  "copyAttachments" : true,
  "copyPermissions" : false,
  "copyProperties" : false,
  "copyLabels" : false,
  "copyCustomContents" : false,
  "destination" : {
    "type" : "existing_page",
    "value" : "2023293113"
  },
  "pageTitle" : "(v24) Include test",
  "body" : {
    "storage" : {
      "value" : "<p>Test content 2</p>",
      "representation" : "storage"
    },
    "raw" : null
  }
}
1 Like
2

Hi @candid,

I’ve created CONFCLOUD-71292 please track this issue there. I’ll also bring this to the ecosystem teams attention.

Thanks,
Ralph