Koha Test Wiki MediaWiki MySQL Binary Upgrade

One of a series of test instances for migrating the Koha Wiki MediaWiki database.

For the current Koha Wiki, visit https://wiki.koha-community.org .

Import biblios oaipmh endpoint RFC

From Koha Test Wiki MediaWiki MySQL Binary Upgrade
Jump to navigation Jump to search

Bugs

Actions and routes

General proposed routes.

Description Action Proposed path
Import an OAI-PMH XML record as a biblio record
 POST
 /import/oaipmh/biblios

Importing an OAI-PMH XML record as a biblio record

OAI-PMH is a protocol which only uses XML, so we have to submit OAI-PMH XML records to the API.

The API endpoint will do add/update/delete as required based on the information in the OAI-PMH XML record and how it corresponds to data saved in the Koha database.

Comments

tcohen

  • I'd prefer /import/biblios/oai_pmh, because we could want another import methods, and I'd prefer to group them by type (i.e. biblios in this case).
  • OAI-PMH might support different data formats, do you have plans for that? The /biblios endpoint uses the Accept header to specify that, maybe Content-type is to play a role here. Even if we don't still support other format than MARCXML at this point.

dcook

Only noticing tcohen's comments a couple years later...

  • I'd be fine with /import/biblios/oai_pmh
  • At the plugin level, it accepts text/xml Content-type since the inbound data is OAI-PMH data which encapsulates MARCXML so can't really use the Content-type here to be more specific
  • Data that isn't MARCXML is silently ignored at the moment. I don't have any plans to support anything other than MARCXML at this point. However, since OAI-PMH is XML, we could always provide a list of acceptable XML namespaces to Koha, and it could judge based on that