Skip to content

Changelog

All notable API changes will be documented in this file. The format is based on Keep a Changelog.

unreleased

Fixed

  • Fixed a bug in bibtext generation that caused a server error when a resource had no title.
  • Fixed a bug where exceptions were wrongfully labeled as cache errors.

4.1.0 - 2026-09-23

Changed

  • Adapted the languages object in the metadata responses according to the current JSONschema changes.

Fixed

  • Updated version number in README.md and openapi_info.yaml to v4.
  • Removed "language_codes" property from the JSON schema from /response-schema.
  • Logging configuration in gen_pids.py now uses a filter to send log messages below ERROR to stdout and ERROR and above to stderr.
  • Fixed a bug in gen_pids.py that caused some missing language properties in the Datacite metadata.

4.0.1 - 2026-09-03

Changed

  • Improved error logging from gen_pids.py when updating Datacite metadata.

Fixed

  • Fixed a git path calculation bug in gen_pids.

4.0.0 - 2026-09-02

Added

  • Added a new route /source/[resource_type]/[resource-id] for retrieving the source metadata for a resource (without applying metadata processing).
  • Collections now have an updated field in the metadata, which - if not set explicitly - is set to the latest updated date of all resources in the collection.
  • Added a new route /resource-schema for retrieving the JSON schema used to validate the metadata YAML files.
  • Added a new route /validate-resource for validating resource metadata (sent in the request body) against the JSON schema.
  • Added a html developer documentation page at /docs/ (rendered with MkDocs).
  • Add support for tracking API usage with Matomo.

Changed

  • /schema route (returning the JSON schema for the resource listings generated by the / endpoint) has been renamed to /response-schema.
  • The swagger documentation is now available at /swagger instead of /docs.
  • gen_pids.py: is now called as a module using uv run -m gen_pids.gen_pids.
  • Changed names and behavior of flags in gen_pids.py. Run with --help to see the new options.
  • gen_pids.py now handles git commits and log rotation.
  • Exchanged jsonschema lib for jsonschema-rs for validating metadata against the schema for better error messages and performance.
  • gen_pids.py: improved handling of resources with multiple languages.

Fixed

  • gen_pids.py --file --force-update now limits Datacite updates to the selected resource and its transitive collection/successor closure instead of updating unrelated relation groups.
  • Fixed bug in gen_pids.py which did not expand resource references with wildcards when generating HasPart relations for collections.
  • Fixed the response model for the / route to correctly reflect the possible return types when using different query parameters (except for the legacy format).
  • Empty entries in the languages field of the metadata are now removed from the API response.
  • gen_pids.py: rightsList now only contains unique entries.
  • Fixed logging bug in cache renewal.

Removed

  • Removed gen_pids.sh script. Use uv run -m gen_pids.gen_pids instead.
  • Removed the deprecated /corpora, /lexicons, /models, /analyses, /utilities and /collections routes. Use the main / route with the resource parameter instead.
  • Removed the legacy query parameter from the / route. The legacy response format (using corpora, lexicons, etc.) is no longer supported.
  • Removed the deprecated /doc route serving the OpenAPI documentation in YAML format. Use /openapi.json instead.

3.3.1 - 2026-03-09

Fixed

  • Fixed a bug in parse_yaml.py that caused the has_description field to be missing from collection metadata.

3.3.0 - 2026-01-15

Added

  • Added atomic tracking of pending cache renewal tasks using Redis to prevent overload.
  • Added support for wildcards using simple glob-style patterns (* and ?) in collection resource references.
  • Added support for type prefixes in collection resource references (e.g. corpus/*).
  • Added purge-license-cache query parameter to /renew-cache route to allow re-downloading license information from SPDX before parsing YAML files.

Changed

  • Improved error messages from gen_pids.py and parse_yaml.py for better clarity.
  • All license fields in the metadata are now transformed into objects containing id, name, and url fields with license details from SPDX.
  • Moved batch programs from tmp_scripts/ to batch_jobs/ directory and refactored code in metadata_util.py.

3.2.0 - 2025-12-03

Added

  • Added an update argument to the gen_pids.sh script to force updates of all Datacite metadata.
  • Added proper license information to Datacite metadata.
  • Added /redoc route for API documentation with ReDoc.
  • Added /docs route for API documentation with Swagger UI.

Changed

  • Flask is replaced with FastAPI as the web framework and the app is run asynchronously.
  • Minimal Python version is now 3.11.
  • The app is now run with uvicorn instead of gunicorn.
  • Cache-renewal is now done in a background task with Celery, using Redis as broker.
  • Change preferred installation method to use uv for dependency management.
  • gen_pids.py now uses logging instead of print statements.
  • Moved some documentation from README.md to docs/dev-docs.md.
  • Slightly improved caching logic.

Deprecated

  • The /corpora, /lexicons, /models, /analyses, /utilities and /collections routes are deprecated and will be removed in a future version. Use the main / route with the resource parameter instead.
  • The /doc route serving the OpenAPI documentation in YAML format is deprecated and will be removed in a future version. Use /openapi.json instead.

Fixed

  • Cache-renewal is only triggered when changes are detected in the main branch of the metadata repo (instead of all branches).
  • Fixed bug in gen_pids.py that caused emtpy resource sized.
  • Fixed Pylance type warnings.

3.1 - 2025-02-28

Added

  • Better error handling and logging for 404 errors.
  • Added documentation about caching.
  • Added possibility to send error messages to a Slack channel. The URL can be configured with the SLACK_WEBHOOK variable.
  • Added a shell script for extracting the version number from __init__.py and changing references to the API version in README.md.
  • When running a test server, the port can now be supplied as an argument to run.py.

Fixed

  • The /schema route now correctly reflects the schema for the resource data returned by the API.
  • Fixed bug that caused errors in logging.
  • Do not delete the app logs during log rotation in gen_pids.sh.
  • Fixed bug in /renew-cache that caused attempts to process non-metadata files.

3.0 - 2025-02-25

Added

  • It is now possible to use a custom config (config.py) for overriding values defined in the default config.
  • Proper logging and better error handling.

Changed

  • Integrated parse_yaml.py into the API. YAML files are now parsed when calling the /renew-cache route.
  • It is now possible to perform a cache refresh with specific updated/deleted resources by supplying the resource-paths parameter to /renew-cache.
  • The format for the resource data has been updated. A json schema will be available soon.
  • The API documentation is now served as JSON instead of YAML (by /doc).
  • It is now possible to add a new resource type by adding it to the RESOURCES dictionary in the config file.

2.0 - 2025-02-14

This version has been developed over a long period and is therefore incomplete. It only contains the latest changes. Please refer to the git commit log for more information.

Added

  • Added a route for creating a bibtex citation for a specific resource: /bibtex?resource=[some-id]
  • Added a route for lising analyses: /analyses
  • Added a route for listing utilities: /utilities
  • Added a script for generating PIDs and registering resources at Datacite.