OAI-PMH Support
(UXPROD-993)
|
|
| Status: | Closed |
| Project: | mod-oai-pmh |
| Components: | None |
| Affects versions: | None |
| Fix versions: | 1.0.0 | Parent: | OAI-PMH Support |
| Type: | Story | Priority: | P2 |
| Reporter: | Hkaplanian | Assignee: | Hkaplanian |
| Resolution: | Done | Votes: | 0 |
| Labels: | sprint48 | ||
| Σ Remaining Estimate: | Not Specified | Remaining Estimate: | Not Specified |
| Σ Time Spent: | Not Specified | Time Spent: | Not Specified |
| Σ Original Estimate: | Not Specified | Original estimate: | Not Specified |
| Issue links: |
|
|||||||||||||||||||||||||
| Sub-tasks: |
|
|||||||||||||||||||||||||
| Sprint: | oai-pmh - sprint 48 | |||||||||||||||||||||||||
| Story Points: | 8 | |||||||||||||||||||||||||
| Development Team: | Thunderjet | |||||||||||||||||||||||||
| Epic Link: | OAI-PMH Support | |||||||||||||||||||||||||
| Description |
|
1. RAML At the end of this story we'll have a skeleton in place with stub methods |
| Comments |
| Comment by Craig McNally [ 05/Oct/18 ] |
|
Craig McNally check with Vince to see if the backend module needs to follow the oai-pmh spec, or if the API can be split up into various endpoints... |
| Comment by Craig McNally [ 05/Oct/18 ] |
|
I discussed with Vince and we agree it makes sense to split up the API into multiple endpoints. One thing that occurred to me was that doing so allows for fine-grained permissions, whereas using a single endpoint would only allow for all-or-nothing permissions. The endpoints should be as RESTful as possible... e.g. GET /oai2?verb=GetRecord on the edge should map to something like GET /record in the module. |
| Comment by Pavel Korolenok [ 09/Oct/18 ] |
|
Hi Craig McNally, I've got a couple of questions about response part of the OAI-PMH endpoints. Edge API Do we want/need to follow this approach in edge API? Back-end module API
What would be the preferable option here? |
| Comment by Craig McNally [ 09/Oct/18 ] |
|
My gut feeling is that we should return applicable 4XX/5XX response codes, I'll take a look at the error codes and try to provide advice on error code -> http status code mappings... e.g. 400 for badVerb, badResumptionToken, badArgument |
| Comment by Pavel Korolenok [ 12/Oct/18 ] |
|
Hi Hkaplanian, |