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

Add ?as=iiif param to top level collections endpoint. #232

Merged
merged 1 commit into from
Jul 24, 2024

Conversation

mathewjordan
Copy link
Member

@mathewjordan mathewjordan commented Jul 22, 2024

This work adds a ?as=iiif param to create a IIIF resource for the top level collection of collections. In the process, we have also extended out Presentation API properties across all collections.

To review, navigate to the your dev API endpoint, ex:
https://mat.dev.rdc.library.northwestern.edu:3002/collections?as=iiif

If you really wanna see these Collections in action, check it out in:
https://theseus-viewer.netlify.app/?iiif-content=https://mat.dev.rdc.library.northwestern.edu:3002/collections?as=iiif

To review:

https://theseus-viewer.netlify.app/?iiif-content=https://dcapi.rdc-staging.library.northwestern.edu/api/v2/collections?as=iiif

Copy link
Contributor

@mbklein mbklein left a comment

Choose a reason for hiding this comment

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

This looks great. The only thing missing is an update to the OpenAPI spec – the /collections route spec needs a reference to the as param (which you can just copy/paste from the /collections/{id} route spec).

I don't think there's anything to update in the docs regarding the Presentation API stuff because we pretty much punted and called all document responses object types.

Copy link
Contributor

@kdid kdid left a comment

Choose a reason for hiding this comment

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

Looks good. Collections search route (/search/collections?as=iiif) working as expected as well with POST body.

@mathewjordan
Copy link
Member Author

mathewjordan commented Jul 23, 2024

This looks great. The only thing missing is an update to the OpenAPI spec – the /collections route spec needs a reference to the as param (which you can just copy/paste from the /collections/{id} route spec).

I don't think there's anything to update in the docs regarding the Presentation API stuff because we pretty much punted and called all document responses object types.

Thanks, updated the spec!

@mathewjordan mathewjordan merged commit bdea6b2 into deploy/staging Jul 24, 2024
2 checks passed
@mathewjordan mathewjordan deleted the 5088-top-as-iiif branch July 24, 2024 13:35
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.

3 participants