First goal it to take existing api urls from webclient, cleanup the api and port them to webgateway.
Some of that work was started at https://github.com/openmicroscopy/openmicroscopy/pull/4357
but more discussion was needed (and this is for 5.3.0 so we don't want to open a PR yet).
First goal it to take existing
api
urls from webclient, cleanup the api and port them to webgateway. Some of that work was started at https://github.com/openmicroscopy/openmicroscopy/pull/4357 but more discussion was needed (and this is for 5.3.0 so we don't want to open a PR yet).I've tried to document the existing api urls and suggest a cleanup in a gist, so that we can have a single document that we're editing until happy: https://gist.github.com/will-moore/2aa7d5eef6481dd3c777
Comments on the gist describe cleanup changes that have been made so far (and you can also inspect the gist versions).
Questions to discuss:
webgateway/api/v1/
E.g. here or in header (E.g. githubfilesetId: 1
befileset: {id: 1}
same as owner and group?permissions
field. E.g."canEdit canAnnotate canLink canDelete"
/containers/
to usedata:{}
wrapper too?/publicContainers/
forshares:[], discussions:[]
and/shares/
to list shares only/images/:id
to return current imgData json? Should/images/
list use similar format?plateAcquisitions
vvacquisitions
vvruns