-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dad62b5
commit f8b5948
Showing
1 changed file
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
title: Develop an OAI-PMH API for the WeGA-WebApp | ||
mentors: | ||
- name: Peter | ||
github: peterstadler | ||
- name: Dennis | ||
github: riedde | ||
skills: | ||
- XQuery | ||
- XML | ||
- REST APIs | ||
forum: https://chat.edirom.de/gsoc | ||
est_project_length: 350 hours | ||
difficulty: medium | ||
--- | ||
|
||
The [WeGA-WebApp] drives the publication of the digital edition of | ||
Carl Maria von Weber's letters, diaries and writings–and much more. | ||
While there are already various interfaces to interact with the WeGA-WebApp an | ||
[OAI-PMH] (Open Archives Initiative Protocol for Metadata Harvesting) API | ||
is still missing. | ||
Because the OAI-PMH standard is a widely-used protocol that allows | ||
repositories to expose structured metadata for harvesting by external | ||
institutions, it is a cornerstone for integrating digital resources into global | ||
research networks. | ||
The API should provide endpoints for common OAI-PMH verbs, such as | ||
`Identify`, `ListMetadataFormats`, `ListIdentifiers`, `ListRecords`, and | ||
`GetRecord`, enabling granular access to the metadata from the WeGA-WebApp. | ||
This would significantly enhance the accessibility, interoperability, and | ||
discoverability of all digital editions served by the WeGA-WebApp, enabling | ||
the project to reach larger academic and cultural audiences. | ||
|
||
The task is to get acquainted with the OAI-PMH standard and the required API | ||
endpoints, and to implement this in XQuery. | ||
You can build on the already established Linked Data and Dublin Core | ||
interfaces of the WeGA-WebApp, and its existing [Swagger OpenAPI]. | ||
The existing Dublin Core metadata interface provides a solid foundation for | ||
defining the metadata exposure required by OAI-PMH, while the Linked Data | ||
interface may inform URI structures. | ||
The Swagger OpenAPI can guide the integration of OAI-PMH endpoints within | ||
the broader API ecosystem of the WeGA-WebApp. | ||
The task should also include testing the implementation for compliance with | ||
the OAI-PMH standard and documenting the API endpoints, including their | ||
functionality and expected parameters, for internal and external users. | ||
|
||
[WeGA-WebApp]: https://github.com/Edirom/WeGA-WebApp | ||
[OAI-PMH]: https://www.openarchives.org/pmh/ | ||
[Swagger OpenAPI]: https://www.weber-gesamtausgabe.de/api/v1/index.html |