Skip to content

v0.1.1 — documentation corrections

Choose a tag to compare

@mpasternak mpasternak released this 22 Jul 18:04
· 41 commits to main since this release

Documentation-only release. No changes to the server, its tools or its behaviour — nothing here is a reason to upgrade beyond having accurate docs on the package page.

Corrected the Compatibility section. The previous wording ("Verified against DSpace 7.2.1, 7.5, ... 11.0-SNAPSHOT") conflated two different things and read as if the code had been test-run on all eight versions. It had not. The section now separates them:

  • the automated tests run against recorded responses from a live DSpace 10.1-SNAPSHOT covering every endpoint the tool uses, plus root/search responses from a vanilla 7.6.5, a DSpace-CRIS 8.2 and an 11.0-SNAPSHOT for comparing response shape;
  • the eight-version list was a by-hand survey of the REST API made while designing the tool — a check of the API, not a test run of this code.

It also makes the more useful point explicit: nothing in the tool branches on a DSpace version number. It asks each instance which search filters, sort fields and facets it supports, because that is configured per installation.

Fixed the PyPI and Python badges, which were serving a cached "package or version not found" from before the package existed.

Reports from versions and configurations I could not test remain very welcome.