SimpleAnnotationServer icon indicating copy to clipboard operation
SimpleAnnotationServer copied to clipboard

API endpoints for indexing manifests, annotation lists, checking if they are indexed

Open rlskoeser opened this issue 2 years ago • 2 comments

I can't tell how to programmatically index manifests and annotation lists, or how to check if they are already indexed.

I want to do bulk automated indexing by script; I'm also interested in automatically indexing on-demand if a user wants to start annotating something that has not been indexed yet.

I see some documentation about the html forms for indexing manifests and populating annotation lists; can these be called from a script? Are there any options for bulk indexing?

rlskoeser avatar Apr 20 '22 20:04 rlskoeser

I have this documentation for indexing annotation lists:

https://github.com/glenrobson/SimpleAnnotationServer/blob/master/doc/Endpoints.md

and I can add the Manifest indexing.

glenrobson avatar Apr 28 '22 10:04 glenrobson

Thank you, @glenrobson — appreciate it.

I was thinking that I need this, but now I'm not sure how essential it is. What does indexing a manifest get me? I see that there is some functionality related to statistics and reporting, and I see the manifest-based search.

If I index my manifests, then I can get all annotations based on the manifest short-id, correct? Will this handle canvases that are included in multiple different manifests and have different annotations in different contexts?

rlskoeser avatar Apr 28 '22 14:04 rlskoeser