Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
pietercolpaert committed Dec 20, 2023
1 parent 62cb5b7 commit 978f993
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
# LDES-DCAT-AP-feeds
This repository will host the ongoing work regarding LDES and DCAT-AP feeds
# DCAT-AP Feeds

[Read the spec](https://semiceu.github.io/LDES-DCAT-AP-feeds/index.html)

Publishing a full data dump over and over again will delegate change detection -- a fault prone process -- to data consumers.
With DCAT-AP Feeds we propose that DCAT-AP catalog maintainers publish an event source API that can help to replicate the catalog towards a harvester, and always keep it in-sync in the way that is intended by the publisher.
Therefore, this spec describes how to publish your DCAT-AP entity changes using the Activity Streams vocabulary and LDES.
It also provides a specification for harvesters to provide transparency into their harvesting progress.

This is a pilot in the SEMIC programme to study the value of Linked Data Event Streams in Europe.
13 changes: 10 additions & 3 deletions spec.bs
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,18 @@ In this spec, examples are provided for both serializations.
Through content negotiation, other formats MAY be provided.

DCAT-AP Feeds uses the [[!activitystreams-vocabulary]] to indicate the type of change.
Three type of activities can be described: a Create and an Update, both upserting a set of quads packaged in a named graph in harvester, and a Remove, that is intended for the removal of previously created or updated set of quads.
These activities MUST provide an object IRI (this thus cannot be a blank node), SHOULD come with a `published` property with an `xsd:dateTime` datatype, and SHOULD provide a type.
Three type of activities can be described:
* a Create (i) or an Update (ii), both upserting a set of quads, packaged in a named graph, in the harvester, and
* a Remove (iii), that is intended for the removal of previously created or updated set of quads.

These activities MUST provide using the property `object` an IRI of the DCAT-AP entity (this thus cannot be a blank node), SHOULD come with a `published` property with an `xsd:dateTime` datatype, and SHOULD provide a type.
The activity MUST be identified using an IRI.
The payload of the DCAT-AP entity MUST be provided in the named graph with the activity IRI as the graph.

Note: When a harvester processes the set of quads in the named graph, it can create or replace all quads in a named graph of the DCAT-AP entity, whom’s IRI then possible is a concatenation of the entity IRI with the LDES IRI in order to ensure that multiple representations of the DCAT-AP entities from various sources can be provided.

Fall-backs for when one of these optional properties are not available:
* The type: then we assume the payload of the named graph needs to be processed as an upsert, similar to an Update or a Create
* The type: cfr. [[!activitypub]], we assume the payload of the named graph needs to be processed as an upsert, similar to an Update or a Create
* `published`: when no timestamp is included, a consumer MUST keep a list of all processed members to not process an already processed one again. Published can however only be omitted in the case of a LatestVersionSubset (see retention policies).

All activities are immutable: once published one cannot alter the same member again.
Expand Down

0 comments on commit 978f993

Please sign in to comment.