Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend asset endpoints to expose "manifests" #952

Open
donaldgray opened this issue Feb 6, 2025 · 0 comments
Open

Extend asset endpoints to expose "manifests" #952

donaldgray opened this issue Feb 6, 2025 · 0 comments
Labels
API https://dlcs-book.readthedocs.io/en/latest/ refined Identify refined tickets in the backlog

Comments

@donaldgray
Copy link
Member

donaldgray commented Feb 6, 2025

The new "manifests" property needs to be added to Hydra Image class and mapped from DB entity and returned for any read/write endpoints.

{
  "@context": "https://api.dlcs.digirati.io/contexts/Image.jsonld",
  "@id": "https://api.dlcs/customers/2/spaces/1/images/first",
  "@type": "vocab:Image",
  "id": "first",
  "manifests": ["m123", "aadopsi0"]
}

This property should be rendered, if set, everywhere the Hydra image class can be returned:

  • GET|PATCH /customers/{c}/spaces/{s}/images
  • POST /customers/{c}/allImages
  • GET|PUT|PATCH /customers/{c}/spaces/{s}/images/{i}
  • GET /customers/{c}/queue/batches/{b}/images
  • GET /customers/{c}/queue/batches/{b}/assets
  • POST /customesr/{c}/queue
  • POST /customesr/{c}/queue/priority
  • verify that the above is the comprehensive list of endpoints, add any that have been missed

For updates, "manifests" can be:

  • An array with values (e.g. ["foo", "bar"]) - this will replace any currently saved values
  • null - this will save null if new asset, or leave any existing "manifests" if update
  • [] - this is explicitly clearing the values, so null in database.
@donaldgray donaldgray added API https://dlcs-book.readthedocs.io/en/latest/ refined Identify refined tickets in the backlog labels Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API https://dlcs-book.readthedocs.io/en/latest/ refined Identify refined tickets in the backlog
Projects
None yet
Development

No branches or pull requests

1 participant