scalableminds/webknossos-libs

wk.Annotation constructor should require organization name

Opened this issue · 2 comments

fm3 commented

When creating a new annotation via a = wk.Annotation(name, dataset_name=dataset_name, voxel_size=voxel_size) it should be required to pass an organization name for the specified dataset to avoid ambiguity.

Otherwise during upload to wk, the lookup can be ambiguous and may fail if other organizations have datasets of that name.

Related: scalableminds/webknossos#7681

I think it still would be better to infer that somehow. There are not many users which are part of multiple organisations. This would make the API more difficult for them.

The other question is: Are organizations referenced by name or ID?

fm3 commented

I think it still would be better to infer that somehow

True, if there is an active webknossos context, the orga of the user can be used automatically.

Are organizations referenced by name or ID

This is a bit of a mess… They are referenced by name (not the display name) (the name that is also the orga directory name in the binaryData directory). However, that field is called organization_id in the libs. I once tried to adapt the webknossos side to do the same, and drop the mongoId entirely in scalableminds/webknossos#7386 but @normanrz stopped me because some external references still use the mongoId values.

Edit: we decided that we want to go ahead with this renaming after all in the coming weeks