Skip to content

Initial support for JSON api /annotations endpoint - #682

Open
will-moore wants to merge 10 commits into
ome:masterfrom
will-moore:api_annotations
Open

will-moore wants to merge 10 commits into
ome:masterfrom
will-moore:api_annotations

Conversation

@will-moore

@will-moore will-moore commented Jun 30, 2026 •

Copy link
Copy Markdown
Member

Fixes #532 - also discussed at #635

Tests added in ome/openmicroscopy#6459

This wraps ome/omero-py#489 and passes query parameters to getObjects().

Adds support for /api/v0/m/annotations/ endpoint, with various query parameters:

  • "image", "dataset", "project", "screen", "plate", "well", "plateacquisition", "roi"
  • ns
  • types of annotation, ("file", "map", "tag", "long", "comment" etc) accessed via e.g. /api/v0/m/mapannotations/

To test:

Also, owner, offset, limit etc work as for other endpoints:

@knabar knabar changed the title Initial support for JSON api /annotaions endpoint Initial support for JSON api /annotations endpoint Jul 1, 2026
Comment thread omeroweb/api/views.py
"""Override get() to allow filtering by annotation type."""

# set self.OMERO_TYPE, then call super().get() to get the list of Annotations
# E.g. conn.getObjects("TagAnnotation") - not actually case-sensitive

@pwalczysko pwalczysko Aug 3, 2026 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that the tests of test_show in https://merge-ci.openmicroscopy.org/jenkins/job/OMERO-test-integration/43/testReport/ might be failing because of this change - the timing of the commit and the timing of the tests starting to fail matches.

@pwalczysko

Copy link
Copy Markdown
Member

excluded to verify #682 (comment)

@pwalczysko

Copy link
Copy Markdown
Member

excluded to verify #682 (comment)

wrong call, including again, sorry

@pwalczysko

Copy link
Copy Markdown
Member
flake8...................................................................Failed
- hook id: flake8

@pwalczysko

Copy link
Copy Markdown
Member

Excluding again, as this PR is coupled with ome/openmicroscopy#6459 and ome/omero-py#489. Will exclude all three to be sure, thanks @sbesson

@pwalczysko

Copy link
Copy Markdown
Member

Removed the exclude label. We need to keep an eye on #682 (comment) tomorrow.

@pwalczysko

Copy link
Copy Markdown
Member

I think the rebase to master shouild be performed here in order to include the black tox build fix in #688 - this is why the last commit did not pass GHA tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JSON API support for Annotations

2 participants