image/video file rename

[davidsean]

I've come across existing images that I would like to rename without breaking file metadata, annotations, image lables etc.

It could be nice to have an API endpoint PUT api/v1/image/:id/

{
  "filename": "newfilename.jpg"
}

or perhaps a batch volume endpoint PUT api/v1/volume/:id/filenames

{
  "IMAGE_ID_1": "newfilename1.jpg",
  "IMAGE_ID_2": "newfilename2.jpg",
}

At the moment the only way I found would be to edit the database at images.filename, and I can't tell if it will risk corrupting the filemetadata entries.

I understand that changing an image filename in a volume will require also manually renaming the original file on the storage-side.

[mzur]

Adding this as an API endpoint wouldn't hurt, I guess. There will only always be the problem that BIIGLE won't touch the original files and if you want to rename files in BIIGLE, you have to update the original files manually.

I'd be hesitant to offer this feature in the UI since then users will try to rename the files and then be confused why they suddenly no longer see their files in the annotation tool (because the original was unchanged).

As a workaround you can also edit the database directly. If you only update the filename, metadata and annotations will remain unchanged. This is basically what the API endpoint would do, too.

[davidsean]

Thanks for confirming that modifying entries under the filename column won't create unintentional consequences in the database. In the short term, I will use this workaround. The API method would be helpful for those that do not have database access (for example, on the biigle.de instance).