API Changes in the BuildVu Microservice

In the 2024.07 release, there will be a change to the zip files generated by the BuildVu microservice. This change affects users of the microservice only. If you are using the BuildVu JAR file directly you are not impacted.

What’s changing?

2024.05 and earlier:

1. The name of the zip file and parent directory was aligned with the name of the original document
2. Inside the zip file, there was a parent directory at the top level which held all the content

Example

MyDocument.zip
└─ MyDocument
    ├─ 1.html
    ├─ 2.html
    └─ etc

2024.07 and later:

1. The name of the zip file is aligned with the uuid of the conversion
2. Inside the zip file, the converted document is stored at the top level without using a parent directory

Example

a96d569a-ec97-421e-997e-f1f23c169fa2.zip
├─ 1.html
├─ 2.html
└─ etc

Why is it changing?

In order to make the microservice more reliable and predictable, we have modified how the microservice stores files internally. This means the microservice no longer needs to reject certain problematic filenames or truncate filenames that are too long.

This improvement would not be possible without changing the naming conventions of the zip file. As changing the parent directory name could impact workflows, we believe it is a good opportunity to instead remove the parent directory entirely as this will simplify workflows that do not need the parent directory. We anticipate that it should not be complicated to accommodate this change.

Where possible, we always try to avoid making API changes that could break the workflows of our customers. In this case it would not be possible to make the improvement without introducing a change, and we believe the benefits outweigh any potential negatives.