search

DSpace / RestContract

REST Contract for DSpace 7-8
https://wiki.lyrasis.org/display/DSDOC8x/
37 stars 48 forks source link

Documentation needed for endpoint `api/pid/find` #185

Open bruno-atmire opened 2 years ago

bruno-atmire commented 2 years ago

Issue

Given a handle, I wanted to query the REST API to access the matching DSpace Object. I searched through the REST contract, but could not find any mention of a REST endpoint to resolve a handle.

After consulting with my colleagues and digging through the Angular code, we found the following endpoint: https://api7.dspace.org/server/#/server/api/pid/find?id=hdl:10673/403

This endpoint does not seem to be documented. Can this be added?

Background info

The /api/pid/find endpoint routes to IdentifierRestController, which calls the IdentifierService, which supports multiple IdentifierProviders. Supported identifier providers include: DOIIdentifierProvider, EZIDIdentifierProvider, HandleIdentifierProvider, etc.

tdonohue commented 2 years ago

Agreed, this documentation is currently lacking. PRs/volunteers welcome!

alanorth commented 3 months ago

Documentation for /server/api/dso/find is also missing. Adding a comment here because I just stumbled upon it and it seems related.