Closed will-moore closed 7 years ago
We decided in today's meeting http://will-moore.github.io/presentations/2017/Web-Api-Update-Jan-2017/#/ that we want to support Images in 5.3.0.
Need to decide what to load by default, what can be optionally loaded (E.g. Pixels, Channels) and how user specifies what to load.
Default behaviour can be different when listing images vv getting a single image. E.g:
/images/ lists images with nothing else loaded (except omero:details) /images/:id/ gets an image that has pixels and channels loaded by default.
/images/
/images/:id/
pixels
channels
Use a load query to specify extra objects to load. E.g:
load
/images/?load=pixels /images/:id/?load=channels NB: this would also load pixels.
/images/?load=pixels
/images/:id/?load=channels
If we need to support multiple objects (in future) could use comma-delimited list: /images/:id/?load=channels,rois
/images/:id/?load=channels,rois
OR use named parameters for each object to load. E.g
/images/?load_pixels=true
cc @chris-allan @aleksandra-tarkowska
Discussed in web api meeting today:
We decided in today's meeting http://will-moore.github.io/presentations/2017/Web-Api-Update-Jan-2017/#/ that we want to support Images in 5.3.0.
Need to decide what to load by default, what can be optionally loaded (E.g. Pixels, Channels) and how user specifies what to load.
Default behaviour (no parameters)
Default behaviour can be different when listing images vv getting a single image. E.g:
/images/
lists images with nothing else loaded (except omero:details)/images/:id/
gets an image that haspixels
andchannels
loaded by default.Loading extra objects
Use a
load
query to specify extra objects to load. E.g:/images/?load=pixels
/images/:id/?load=channels
NB: this would also load pixels.If we need to support multiple objects (in future) could use comma-delimited list:
/images/:id/?load=channels,rois
OR use named parameters for each object to load. E.g
/images/?load_pixels=true
cc @chris-allan @aleksandra-tarkowska