https://github.com/lblod/harvesting-verenigingen-import-service

https://github.com/lblod/harvesting-verenigingen-import-service

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lblod/harvesting-verenigingen-import-service
• Owner: lblod
• Created: 2024-02-05T09:00:11.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-05-30T13:41:01.000Z (7 months ago)
• Last Synced: 2024-05-30T15:58:51.567Z (7 months ago)
• Size: 21.5 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# harvesting-import-service

Microservice that harvests knowledge about a harvesting-task from the linked annotated documents

and writes the resulting triples to the database.

## Installation

To add the service to your stack, add the following snippet to docker-compose.yml:

```

services:

  harvesting-import:

    image: lblod/harvesting-import-service:x.x.x

    volumes:

      - ./data/files:/share

```

## Configuration

### Delta

```

  {

    match: {

      predicate: {

        type: 'uri',

        value: 'http://www.w3.org/ns/adms#status'

      },

      object: {

        type: 'uri',

        value: 'http://redpencil.data.gift/id/concept/JobStatus/scheduled'

      }

    },

    callback: {

      method: 'POST',

      url: 'http://harvesting-import/delta'

    },

    options: {

      resourceFormat: 'v0.0.1',

      gracePeriod: 1000,

      ignoreFromSelf: true

    }

  },

```

This service will filter out   with operation .

### Environment variables

 - TARGET_GRAPH: refers to the graph where the harvested triples will be imported into.

 Defaults to .

## Validation and correction

The service will lis

The service will validate the triples to import and will try its best to correct the ones that it founds invalid.

Valid, invalid and corrected triples are written to a file.

## REST API

### POST /delta

Starts the import of the given harvesting-tasks into the db

- Returns `204 NO-CONTENT` if no harvesting-tasks could be extracted.

- Returns `200 SUCCESS` if the harvesting-tasks where successfully processes.

- Returns `500 INTERNAL SERVER ERROR` if something unexpected went wrong while processing the harvesting-tasks.

## Model

See [lblod/job-controller-service](https://github.com/lblod/job-controller-service)