v4.0.0
Change Log
- refactor much of the structure of the linked data module
- refactor language processing of linked data results
- add extended context to linked data search results
- fix processing of IriTemplate mapping expansion
- add versioning to linked data configurations
- deprecate linked data config version 1.0
- update LOC and OCLCFAST linked data configs to config version 2.0
- update URL for fetching a single term from Getty through the non-linked data module
- catch and log Getty response errors
- provide better error messages with json error returned instead of empty results
- replace deprecated URI.escape with ERB::Util.url_encode
- put mesh task in the qa namespace
- remove older deprecated code
- move documentation from the README to the wiki
Actions Required to Upgrade
You do not need to take any actions for this upgrade other than adjusting your gem file to allow for version 4.0.0 to be included by bundler.
Linked Data Configurations
You may want to update the linked data configurations you are using to avoid a deprecation notice. These configurations are now being versioned with the config format used prior to this release being version 1.0. This releases version is 2.0.
There are several changes from 1.0 to 2.0...
- Configs start by identifying the version number (e.g.
QA_CONFIG_VERSION=2.0
). If missing, it is assumed to be 1.0 for backward compatibility. - 2.0 fixes a misuse of IriTemplates in 1.0 where all variables in the template were specified using
{?var}
which was expanded tovalue
. The specification indicates that variables can be specified as{?var}
which expands tovar=value
OR as{var}
which expands tovalue
. If a config is marked as 1.0 (or not marked with a version) then the incorrect expansion is used for backward compatibility. Going forward the correct expansion is used in 2.0 and later versions. - Configs now support expanded context configuration which allows a site to identify additional data to include in search results that can be used in a UI to facilitate an accurate selection process.
Additional linked data authority configurations that are compatible with the QA linked data module are also defined in LD4P/linked_data_authorities. To use, copy the config file to /config/authorities/linked_data in your app. Additional instructions in the linked_data_authority repository.