Skip to main content

VoID

This service implements the VoID protocol, which allows to publish metadata about a dataset.

Features

  • Deploys an endpoint on the /.well-known/void path
  • Automatically find the containers from the LDP service
  • Also find the number of resources, and the blank nodes

Dependencies

Install

$ yarn add @semapps/void

Usage

const { VoidService } = require('@semapps/void');

module.exports = {
mixins: [VoidService],
settings: {
baseUrl: 'http://localhost:3000/',
ontologies : [
{
prefix: 'rdf',
url: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#'
},
{
prefix: 'ldp',
url: 'http://www.w3.org/ns/ldp#',
}
],
title: "My instance",
description: "Description of my instance"
}
};

Settings

PropertyTypeDefaultDescription
baseUrlStringrequiredBase URL of the server
ontologiesArrayrequiredList of ontology used (same format as LdpService)
titleStringTitle of your instance. Will be displayed in the VOID endpoint.
descriptionStringShort description of your instance. Also display in the VOID endpoint