natlibfi/koha-plugin-rest-di

REST API plugin for Koha to provide additional functionality for discovery interfaces such as VuFind

koha-plugin-rest-di

This is a REST API plugin for Koha. It provides extended API support for Discovery Interfaces such as VuFind.

Note that this plugin requires Koha functionality that is only available from Koha 23.11. Releases for other versions are also available.

Most of the functionality has been ported from the KohaSuomi version of Koha (see https://github.com/KohaSuomi/Koha).

Not all the functionality has been thoroughly tested yet.

See CHANGELOG.md for information about changes in this plugin.

Downloading

You can download the relevant *.kpz file from the release page.

Latest version may not support older Koha versions. Please choose an appropriate version.

Installing

The plugin is installed by uploading the KPZ (Koha Plugin Zip) package of a released version on the Manage Plugins page of the Koha staff interface.

To set up the Koha plugin system you must first make some changes to your install:

1. Change <enable_plugins>0<enable_plugins> to <enable_plugins>1</enable_plugins> in your koha-conf.xml file.
2. Confirm that the path to <pluginsdir> exists, is correct, and is writable by the web server.
3. Restart your webserver.

Once the setup is complete you will need to enable plugins by setting UseKohaPlugins system preference to 'Enable'.

You can upload and configure the plugin on the Administration -> Plugins -> Manage Plugins page.

Required User Permissions

To use all the functionality the plugin provides, the following permissions are needed for the user account used to authenticate for the API:

• circulate_remaining_permissions
• catalogue
• borrowers
  • edit_borrowers
  • view_borrower_infos_from_any_libraries
• reserveforothers
• modify_holds_priority
• place_holds
• updatecharges
  • payout
  • remaining_permissions

Installing without a KPZ package

If you need to use the plugin without a KPZ package (e.g. to use a version cloned from git):

1. As above, make sure the plugin system is configured and enabled.
2. Create the path Koha/Plugin/Fi/KohaSuomi/ under the <pluginsdir>
3. Symlink the DI.pm file and DI directory to the Koha/Plugin/Fi/KohaSuomi/ directory.
4. Add data for the plugin to Koha's MySQL database by running Koha's misc/devel/install_plugins.pl script from the command line.

Building a Release

Travis will build the release provided the commit includes a suitable version tag:

1. git tag -a vX.Y.Z -m "Release X.Y.Z" (Feel free to provide a longer message too, it's displayed on the Releases page)
2. git push --tags origin main

To manually build a release locally, run ./build.sh.

koha-plugin-rest-di's Issues

Missing descriptions for some holdings columns

Some columns in the response from /api/v1/contrib/kohasuomi/availability/biblios/{biblio_id}/search have descriptions (like collection_code_description, location_description), but holding_library_id, home_library_id, effective_item_type_id. and item_type_id don't have description equivalents.

I suppose one could argue that you can fetch this information from other API endpoints and then provide your own mappings as necessary, but it would be very convenient to have those passed back in the response.

Hold availability is true when it should be false

The scenario is that I've already placed an item level hold on Item A for Record A.

The API response for the "hold" endpoint says that holds are available at the record level and the item level, but if you go into the Koha OPAC, it'll say the following:

At the record level: "You already have at least one item level hold on this title. All further holds must be item level."

At the item level: "This title cannot be requested because you already have hold for this item."

/api/v1/contrib/kohasuomi/biblios/{biblio_id}/holdings doesn't work for mainstream Koha

It looks like the route /api/v1/contrib/kohasuomi/biblios/{biblio_id}/holdings will only work with Koha Suomi (or Koha implementing the MARC Holdings functionality)

Version must be a number

koha-plugin-rest-di/Koha/Plugin/Fi/KohaSuomi/DI.pm

Line 29 in 6c32574

minimum_version => '23.06.00.054',

Version compare use numeric operator so version min and max must be a number (with decimal).
Otherwise it generates a warning in Perl logs.
For example 23.06.00.054 => 23.0600054

Typo in BiblioController.pm POD

koha-plugin-rest-di/Koha/Plugin/Fi/KohaSuomi/DI/BiblioController.pm

Line 30 in 87b06a5

A class implementing the controller methods for the patron-related API

Looks like a copy paste from PatronController.pm ;)

hold_queue_length at bib-level always 0 for /api/v1/contrib/kohasuomi/availability/biblios/{biblio_id}/hold

The hold_queue_length is 0 at the record-level even when there is a record-level hold already in place for that patron.

The hold_queue_length for the items is correct, but not at the record/bib-level.

Make this upstream?

Hi, I'm all in to make this into Koha upstream this cycle. Can we talk about it?

Ignore suspended holds in hold queue length calculation

Since suspended holds are not relevant for users, they should be ignored when calculating hold queue length.

hold_queue_length shows 0 instead of 1 for api/v1/contrib/kohasuomi/availability/biblios/{biblio_id}/hold

The hold_queue_length should be the equivalent of the "Number of holds" on the OPAC or the counter of "Holds" from /cgi-bin/koha/reserve/request.pl on the staff interface

GIT mode : use misc/devel/install_plugins.pl

koha-plugin-rest-di/README.md

Line 56 in 6c32574

4. Add data for the plugin to Koha's MySQL database:

This should not be necessary with the script from Koha sources misc/devel/install_plugins.pl

Unblessing breaks calling C4::Circulation::TooMany on CirculationRule.pm

Bug where the change was made: Bug 32496: Reduce unnecessary unblessings of objects in Circulation.pm

Missing methods

Hi,

A plugin should always define methods install, upgrade and uninstall, even empty.
Indeed they are called and must return 1 to say OK.

See for example:
biblibre/koha-plugin-theme-intranet-lsd@5bd213b

And:
https://github.com/bywatersolutions/koha-plugin-coverflow/blob/master/Koha/Plugin/Com/ByWaterSolutions/CoverFlow.pm#L201