Notice: In order to edit this ticket you need to be either: a Product Owner, The owner or the reporter of the ticket, or, in case of a Task not yet assigned, a team_member"

Task #4892 (closed)

Opened 8 years ago

Closed 8 years ago

Alert community to API changes

Reported by: wmoore Owned by: wmoore
Priority: minor Milestone: OMERO-Beta4.3
Component: General Version: n.a.
Keywords: n.a. Cc:
Resources: n.a. Referenced By: n.a.
References: n.a. Remaining Time: 0.0d
Sprint: 2011-04-21 (10)

Description (last modified by wmoore)

Need to update http://trac.openmicroscopy.org.uk/ome/wiki/Api/BlitzGateway with a bit more info? Then post to lists and forums saying 'watch this space'. Need to discuss what guarantees of stability we can give. Current e-mail text below.

The BlitzGateway? API, as described http://trac.openmicroscopy.org.uk/ome/wiki/OmeroPy/Gateway and used by the OmeroWeb framework is being substantially revised in the 4.3 release of OMERO, scheduled for June 2011.

These changes aim to reduce the number of methods, while increasing the available functionality.

The details of which methods are being removed, and how to achieve the same functionality from new methods can be found http://trac.openmicroscopy.org.uk/ome/wiki/Api/BlitzGateway (summarised below).

The BlitzGateway? API is an attempt to unify all of our internal uses of the OMERO API while providing a more pythonic interface to end-users. This is, however, a work in progress, and feedback is very much welcome. The page above will be kept up to date with changes as the release approaches.

Do note that some of the methods which could not yet be removed in the refactoring are not intended for general consumption. Such internal methods will be documented and should be used sparsely if at all.

Following the 4.3 release, further improvements will be made on the BlitzGateway? API, but we will be doing our best to minimise the impact on users of the documented public methods.

For more details about this work on the Blitz Gateway, please see http://trac.openmicroscopy.org.uk/ome/wiki/OmeroPy/GatewayInfo

To summarise the changes currently planned for the 4.3 release:

All these methods are being replaced by either getObjects() or getObject():
getProject, getDataset, getScreen, getPlate, getImage, getFileAnnotation, getCommentAnnotation, getTagAnnotation, getGroup, findProject, lookupTagAnnotation

This method is being replaced by getAnnotationLinks():
listImages

All search methods are being replaced by searchObjects():
searchImages, searchDatasets, searchProjects, searchScreens, searchPlates, simpleSearch

The following delete methods are being replaced by deleteObjects():
deleteImage, deleteImages, deleteProject, deleteDataset, deleteScreen, deletePlate, simpleDelete.

Change History (6)

comment:1 Changed 8 years ago by wmoore

  • Description modified (diff)

comment:2 Changed 8 years ago by cxallan

  • Sprint changed from 2011-04-07 (9) to 2011-04-21 (10)

Moved from sprint 2011-04-07 (9)

comment:3 Changed 8 years ago by wmoore

  • Status changed from new to accepted

comment:4 Changed 8 years ago by wmoore

  • Description modified (diff)

comment:5 Changed 8 years ago by wmoore

  • Description modified (diff)

comment:6 Changed 8 years ago by wmoore

  • Remaining Time changed from 1 to 0
  • Status changed from accepted to closed
Note: See TracTickets for help on using tickets. You may also have a look at Agilo extensions to the ticket.

1.3.13-PRO © 2008-2011 Agilo Software all rights reserved (this page was served in: 0.99793 sec.)

We're Hiring!