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

Provide an endpoint to output manifest information for all MMS-ID Materials #6544

Open
1 of 3 tasks
tpendragon opened this issue Nov 14, 2024 · 0 comments
Open
1 of 3 tasks

Comments

@tpendragon
Copy link
Contributor

tpendragon commented Nov 14, 2024

Reasoning

DACS wants to update their indexing to include Figgy resources as part of the facets in the catalog. The easiest way to do that is to enable them to grab all the current complete MMS-ID resources, their manifest URLs, portion notes, and visibility so they can index it in their logic.

Timing

  • Next 3 weeks

Acceptance Criteria

  • There's an endpoint (/reports/mms_records.json) which outputs a hash of all complete MMS-ID resources with the following format:
  • The endpoint above can only be accessed using an auth token that adds the catalog_sync group.
{
   "<mms_id>": {
      "iiif_manifest_url": "<manifest_url>",
      "portion_note": "<portion_note>",
      "visibility": "open"
   }
}

Open Questions

  1. What should the URL be?
  • /reports/mms_records.json
  1. Do we need to cache at all?
  • Try without caching first.

First Step

Write a test.

Useful Background

We ran a similar report here: #6324 (comment)

Sudden Priority Justification

DACS would like to get this implemented in the new year, and we're a blocker for this feature that will bring value to their users and increase the usage of our digitized materials.

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

No branches or pull requests

1 participant