Skip to main content

Invenio resources module to create REST APIs.

Project description

https://github.com/inveniosoftware/invenio-records-resources/workflows/CI/badge.svg https://img.shields.io/coveralls/inveniosoftware/invenio-records-resources.svg https://img.shields.io/github/tag/inveniosoftware/invenio-records-resources.svg https://img.shields.io/pypi/dm/invenio-records-resources.svg https://img.shields.io/github/license/inveniosoftware/invenio-records-resources.svg

Invenio Resources module to create REST APIs

TODO: Please provide feature overview of module

Further documentation is available on https://invenio-records-resources.readthedocs.io/

Changes

Version v9.1.0 (released 2026-02-12)

  • feat(facets): add DateFacet for date histogram ranges

Version v9.0.0 (released 2026-01-30)

  • chore(setup): bump dependencies

  • fix: DeprecationWarning from invenio-indexer

  • chore: remove warnings

  • fix: RemovedInMarshmallow4Warning

  • fix(chore): DeprecationWarning stdlib

  • fix: removed dependency on PyFilesystem2

  • refactor: remove context usage

  • fix: avoid deepcopy in EndpointLink bc of possible problematic context content

  • fix: black formatting

  • fix: re-add removed import

  • feat: expose FileEndpointLink at services import level

  • feat: add support for anchor in EndpointLink

  • refactor: use EndpointLink in RecordTypeFactory [+]

Version v8.8.0 (released 2026-01-08)

  • fix(files-svc): clean up broken FileInstances when an upload fails

  • fix(files-mgr): remember file information before write operations

  • feat(search): allow enforcing a max page size

Version v8.7.1 (released 2025-12-09)

  • i18n: pulled translations

Version v8.7.0 (released 2025-11-17)

  • feat(records): return page number in RecordList

Version v8.6.2 (released 2025-10-22)

  • i18n: pulled translations

Version v8.6.1 (released 2025-09-25)

  • fix(multipart): recompute full file checksum if no parts are set

  • fix(service): track errors on commit for create_update_many

Version v8.6.0 (released 2025-07-31)

  • services: CompositeSuggestQueryParser: Add term filter clause
    • Adds support for filtering suggest query results by subtypes extracted from the query string using a colon-separated format (e.g., “subtype1,subtype2:query”).

    • When subtypes are specified, results are restricted to those subtypes using a terms filter clause combined with the multi-match query.

Version v8.5.0 (released 2025-07-17)

  • tests: simplify s3 tests and make compatible with uv

  • sphinx: make compatible w/ Python 3.13

  • links: move deprecation warning in object instantiation

  • i18n: pulled translations

Version v8.4.0 (released 2025-07-16)

  • requests: add support for multi entity resolution
    • So far all requests were single entity resolution, this adds support for multi entity resolution in the same request. This is useful for example when you want to assign multiple reviewers in a request.

Version v8.3.0 (released 2025-07-02)

  • fix: pkg_resources DeprecationWarning

  • tests: Add unit tests

  • fix: EDTFDateStringCF dump/load to support multiple values

  • fix: raise size limit for multipart file parts

  • ci: remove outdated feature CI

Version v8.2.0 (released 2025-06-23)

  • errors: add ValidationErrorGroup
    • Adds a new exception class to allow raising multiple validation errors.

    • This class is actually a variation of the existing ValidationErrorWithMessageAsList exception defined in invenio-rdm-records.

  • tests: HTTP Range tests

Version v8.1.0 (released 2025-06-04)

  • permissions: Raise correct exception if file does not exist

Version v8.0.0 (released 2025-06-03)

  • feat: Pluggable transfers and multipart transfer implementation * Implementation of RFC 0072 * Pluggable transfer types * Implementation of multipart transfer in the same place * Permission generator for per-transfer-type permissions

Version v7.3.0 (released 2025-04-29)

  • config: move allow_upload and allow_archive_download to service

  • urls: locate Link warning more appropriately

Version v7.2.0 (released 2025-04-22)

  • urls: introduce invenio_url_for-compatible links

Version v7.1.0 (released 2025-04-02)

  • files: remove HTTP code from read_content * Should resolve file content issues with S3

  • i18n: fix untranslated strings in facet

  • il8n: replaced gettext with lazy gettext completely

  • i18n: removed deprecated messages

  • setup: dashes no longer work in setup.cfg babel options

Version v7.0.2 (released 2025-03-10)

  • services: records: CompositeSuggestQueryParser: Filter out stopwords

Version v7.0.1 (released 2025-02-06)

  • fix: file uploads for >100MB

Version 7.0.0 (release 2024-12-09)

  • setup: change to reusable workflows

  • setup: bump major dependencies

Version v6.5.0 (released 2024-11-26)

  • queryparser: add CompositeSuggestQueryParser
    • Introduces a new query parser focused on better accuracy for mappings that contain search-as-you-type or ngram-analyzed fields but also secondary information fields that helps to disambiquate/narrow-down results.

Version v6.4.0 (released 2024-11-08)

  • transformer: add new RestrictedTerm and RestrictedTermValue to restrict search for individual fields based on permissions

Version v6.3.1 (released 2024-10-01)

  • uow: moved Unit of Work pattern and non-record Operations to invenio-db. Added backwards compatible imports.

Version v6.3.0 (released 2024-08-08)

  • files: sync file access status

  • files: syncing metadata changes for uploaded files

  • files: update for retriveing files bucket

Version v6.2.0 (released 2024-08-02)

  • service: add bulk create/update method

Version v6.1.1 (released 2024-07-30)

  • services: reraise permission errors for records

Version 6.1.0 (released 2024-07-05)

  • files: sync metadata on file edit

Version 6.0.0 (released 2024-06-04)

  • uow: updated Task Operation to use apply_async instead of delay

  • uow: added Revoke Task Operation

Version 5.9.2 (released 2024-05-22)

  • isort: fix imports

Version 5.9.1 (released 2024-05-22)

  • errors: add error handler for RecordPermissionDeniedError

Version 5.9.0 (released 2024-05-22)

  • errors: add RecordPermissionDeniedError

Version 5.8.0 (released 2024-05-21)

  • processors: optionally use PyVIPS for image metadata

Version 5.7.0 (released 2024-05-06)

  • files-schema: hide uri from serialization

  • records: added access field to files

Version 5.6.0 (released 2024-04-23)

  • services: add support for nested links

Version 5.5.0 (released 2024-04-09)

  • records: add calculated system field with indexing; allows calculated system field to cache the value in the index, and use the cached value when reading from the index.

Version 5.4.0 (released 2024-03-22)

  • installation: upgrade invenio-app, invenio-base, invenio-accounts (removes before_first_request_deprecation)

Version 5.3.0 (released 2024-03-20)

  • facets: provide new CombinedTermsFacet (facet to use for nested subjects)

Version 5.2.4 (released 2024-02-27)

  • processors: updated file metadata extractor to handle multi-sequence images

Version 5.2.3 (released 2024-02-16)

  • schema: avoid mutating original data in pre_load

Version 5.2.2 (released 2024-02-09)

  • models: restore file record key unique index

Version 5.2.1 (released 2024-02-09)

  • models: remove unique constraint for file record key

Version 5.2.0 (released 2024-02-05)

  • models: fix record file indices

  • models: add index on object_version_id

  • tasks: improve exception log grouping

Version 5.1.0 (released 2024-02-02)

  • queryparser: add search field value mapping

Version 5.0.0 (released 2024-01-29)

  • installation: bump invenio-accounts

Version 4.19.0 (2024-01-18)

  • file manager: copy from other bucket to improve performance

Version 4.18.3 (2023-12-13)

  • files: limit amount of files in the REST API

Version 4.18.2 (2023-12-08)

  • records: allow overriding of permission action for read method

Version 4.18.1 (2023-11-30)

  • files: fix unknown extension return value

Version 4.18.0 (2023-11-29)

  • custom_fields: fix EDTF datetime field

  • files: changed file key type to string

  • files archive: handle broken files

Version 4.17.2 (2023-11-21)

  • api: add get file extension from key

Version 4.17.1 (2023-11-09)

  • api: do not synchronise db session on delete statement

Version 4.17.0 (2023-11-07)

  • file manager: add teardown method (optimise performance)

  • api: add remove_all to FileRecord (optimise performance)

Version 4.16.3 (2023-10-26)

  • files: updated urls for published files

  • files: allowing slash in url

Version 4.16.2 (2023-10-25)

  • error: improve error wording in FailedFileUploadException

Version 4.16.1 (2023-10-25)

  • files: abort with 400 on upload failures

Version 4.16.0 (2023-10-23)

  • uow: add record delete index op

Version 4.15.0 (2023-10-20)

  • base: add possibility to override search options class

Version 4.14.1 (2023-10-19)

  • sort: fallback safely to sort_options

Version 4.14.0 (2023-10-19)

  • services: custom_fields: date: use parse_edtf from babel-edtf

  • params: validate param option against all available options if exist

Version 4.13.0 (2023-10-19)

  • resolver: raises PIDDoesNotExistError when record is deleted

Version 4.12.0 (2023-10-11)

  • setup: upgrade marshmallow-utils

Version 4.11.7 (2023-10-02)

  • bump invenio-stats

Version 4.11.6 (2023-10-02)

  • components: handle file upload interruption

Version 4.11.5 (2023-09-29)

  • service: add extra_filter to reindex method

Version 4.11.4 (2023-09-28)

  • params: make sort/facets params immutable

Version 4.11.3 (2023-09-19)

  • revert fix bool comparison in api

Version 4.11.2 (2023-09-18)

  • api: fix bool comparison

Version 4.11.1 (2023-09-15)

  • records: added link template for read_many calls.

Version 4.11.0 (2023-09-14)

  • expanded fields: add null checks

  • files: set bucket quota

  • service: add sort to read_many

Version 4.10.1 (2023-09-12)

  • systemfields: revert files dumping

  • systemfields: support conditional dumping of files

Version 4.10.0 (2023-09-05)

  • uow: run bulk indexing on post commit hook

Version 4.9.1 (2023-09-05)

  • files: dump files order and preview only if entries are dumped (revert)

Version 4.9.0 (2023-09-05)

  • files: dump files order and preview only if entries are dumped

Version 4.8.0 (2023-08-25)

  • services: move reindex latest records to drafts-resources

  • processors: make image formats (checked for metadata) configurable (#484)

Version 4.7.0 (2023-08-16)

  • Implement file syncing when publishing a record

  • Fixes deletion of files to default to soft deletion unless the correct flags are being used.

Version 4.6.0 (2023-08-14)

  • service: add a method to reindex all record’s versions, with the latest first.

Version 4.5.0 (2023-07-11)

  • relations: reindex by chunk

Version 4.4.0 (2023-07-11)

  • make files component file attributes configurable

Version 4.3.0 (2023-06-15)

  • upgrade invenio-accounts

Version 4.2.0 (2023-06-02)

  • schemas: fix ‘size’ value not being dumped if it is 0

  • expanded fields: add a non-resolvable system record

Version 4.1.0 (2023-05-04)

  • add ServiceResultResolver and ServiceResultProxy

Version 4.0.0 (2023-04-24)

  • files: add support for files metadata indexing

Version 3.0.0 (2023-04-20)

  • query parser: add allow list and fields to fine tune query parsing

Version 2.0.0 (2023-03-24)

  • expandable-field: add a new abstractmethod called ghost_record that returns the unresolvable representation aka “ghost” of the expanding entity.

  • global: renames resolvers to entity_resolvers

Version 1.3.1 (2023-03-23)

  • custom-fields: control field_cls customization

Version 1.3.0 (2023-03-17)

  • errors: add FileKeyNotFoundError

Version 1.2.1 (2023-03-14)

  • setup: install invenio_stats

Version 1.2.0 (2023-03-13)

  • resource: add event emitter for usage statistics calculation

Version 1.1.1 (2023-03-08)

  • dependencies: bump flask-resources

Version 1.1.0 (2023-03-02)

  • remove deprecated flask-babelex dependency and imports

  • upgrade invenio-pidstore, invenio-records-permissions, invenio-i18n, invenio-records

Version 1.0.9 (2023-02-24)

  • serialization: remove files URI for local files

Version 1.0.8 (2023-02-13)

  • service: add record indexer service mixin

Version 1.0.7 (2023-02-06)

  • service utils: add utility to map query parameters to a dictionary based on the service config

Version 1.0.6 (2023-01-23)

  • resources: add archive download endpoint for record files

Version 1.0.5 (2023-01-10)

  • facets: add facet not found exception

Version 1.0.4 (2022-12-19)

  • search: added query parse cls to search config

Version 1.0.3 (2022-12-01)

  • Breaking change: FieldsResolver.expand() method is changed to require an identity parameter.

  • Breaking change: LinksTemplate.expand() method is changed to require an identity parameter.

Version 1.0.2 (2022-11-25)

  • Add i18n translations.

Version 1.0.1 (2022-11-15)

  • Compute file status based on storage class.

  • Use bulk indexing on when rebuilding indices.

Version 1.0.0

  • Initial public release.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

invenio_records_resources-9.1.0.tar.gz (133.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

invenio_records_resources-9.1.0-py2.py3-none-any.whl (264.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file invenio_records_resources-9.1.0.tar.gz.

File metadata

File hashes

Hashes for invenio_records_resources-9.1.0.tar.gz
Algorithm Hash digest
SHA256 b808cab9a999183ac14d88746582ff444794d4c6366d614365949ec4eb01c008
MD5 071935a2442743448477bf420a76c7d3
BLAKE2b-256 e687066cef32562f760c8d4553c8dc09b244868d222d503967abb41a16073e7d

See more details on using hashes here.

File details

Details for the file invenio_records_resources-9.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for invenio_records_resources-9.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 03b6a76bcdf7597a622927b26a532a0eea3b81372c3cd260459f3d3f86711c0d
MD5 217c104f1916fd1d9e3e842ee65ed2de
BLAKE2b-256 39b78853bc3335de7f38c4fad4e61726246ab3fa01ab9a244a86e83676ef6939

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page