Skip to content

Metadata API v4.0.0

Choose a tag to compare

@anne17 anne17 released this 02 Sep 12:04
· 17 commits to main since this release

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.