Shipment API definition

[M3nin0]

The Shipment API will be responsible for sending the publications to digital dissemination and preservation services.

For this case, the module approach, already adopted in Storm Platform, will be used. Thus, a main module, storm-shipment, will be defined, which will serve as a meta-package for other micro-components (storm-shipment-*). In these microcomponents will be the implementations that will send the Storm WS content to the other platforms.

To exemplify in practice the logic of this organization, considering initially that Storm WS will send data to Zenodo, Geo Knowledge Hub, and Storm Portal, we will define the following package structure:

• storm-shipment (Metapackage)

  • storm-shipment-zenodo: Microcomponent for sending data to Zenodo;
  • storm-shipment-gkhub: Microcomponent for sending data to Geo Knowledge Hub;
  • storm-shipment-portal: Microcomponent for sending data to the Storm Portal

With this structure, it will be possible to implement, individually and on-demand, the resources necessary for sending users' jobs to different services.

Initially, we will support only the Geo Knowledge Hub implementation. But in the future, we may support other services.

[M3nin0]

Maybe, this module must provide two route endpoints:

• /exporter: For shipment exporter configurations and record metadata update
• /shipment: For shipment the content.