buda-base / manifest-tk

BDRC Image Manifest file specs, API doc and toolkit (JS + Java)

BDRC Image Manifest doc and API

This repository contains documentation and API endpoints for BDRC image manifests.

The BDRC Image Manifests are json file present in the s3 directory of the corresponding images. It contains information such as:

• the order of images
• the pagination information
• some basic layout information (physical dimensions, margins, inter line space, etc.)

See the examples/ directory for some examples.

API

The API to access and write the manifest files is rather simple:

GET https://iiifpres.bdrc.io/im/{volumeId}

for reading (no access restriction), and:

PUT https://iiifpres.bdrc.io/im/{volumeId}

for writing an image manifest, knowing that:

• the request must have an Authorization header with a token valid for BDRC
• the given document must have a spec-version field and respect the json schema corresponding to the version (TODO)
• the document must have a rev field, and a mechanism similar to CouchDB's will be used to check that no conflict happened

manifest-tk's Issues

add timestamp of the dimensions.json used to create the manifest

The format should contains the timestamp of the dimensions.json (I'm not actually sure the current API gives it... it should be taken care of first probably) used to create the file, so that we know if an update to dimensions.json was made since.