oarepo-model-builder-files 4.0.19

No project description provided

OARepo model builder files

Plugin adding support for working with files based on the invenio model.
Files are represented as another ("file") record connected with the original parent one. The plugin generates the file record and modifies the parent record to create connection with new file one. The file record is specified under "files" attribute in the model yaml file, see example in tests.

The plugin runs the original model builder on the files model in "files" profile, reusing a lot of the model builder code with different configuration, notably with different base classes for record, service, resource and config classes. To get an idea which code is reused, see entrypoints. For configuration changes, see model preprocessors.

Api

The files plugin provides an api for working with files. The api is by default accessible at {original model url}/{base record id}/files. The api is taken from InvenioRDM, the docs are here

Example

A simple record with associated files can be defined as this:

record:
  properties:
    metadata:
      properties:
        title:
          type: fulltext
        status:
          type: keyword
  module:
    name: thesis
  use:
    - invenio

files:
  properties:
    metadata:
      properties:
        title:
          type: fulltext
  module:
    name: thesis
  use:
    - invenio_files
settings:
  schema-server: 'local://'

Using the api, first an instance of the model has to be created. Then an instance of the associated file record. The file content is then uploaded in separate step and finally the upload must be commited.