Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ddeboer/erfgoedpod-sequences
https://github.com/ddeboer/erfgoedpod-sequences
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ddeboer/erfgoedpod-sequences
- Owner: ddeboer
- Created: 2021-02-25T08:42:05.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-22T15:46:29.000Z (almost 4 years ago)
- Last Synced: 2024-11-16T06:53:36.781Z (3 months ago)
- Size: 43.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HTTP sequences for Erfgoedpod
_Run `./render.sh` to generate the diagrams locally_
## Preliminaries
### WebID
Simple universal identification mechanism for the Web and a core aspect of Solid. Used in ErfgoedPod to identify acting organisations in the network (eg. a Cultural Heritage Institution, a Registry, ...)
Example: http://kb.nl#me
### Linked Data Notifications (LDN)
Communication protocol between two actors in the network. Defines an inbox to receive an LDN. An inbox can be discovered thorugh a `Link` header when requesting a resource, like the WebID.
Spec: [](https://www.w3.org/TR/ldn/)
Example:
``` http
POST /inbox HTTP/1.1
Host: registry.nde.nl
Content-Type: application/ld+json;profile="https://www.w3.org/ns/activitystreams"
Content-Language: en
{
"@context": "https://www.w3.org/ns/activitystreams",
"summary": "KB created dataset.ttl",
"type": "Create",
"actor": "http://kb.nl#me",
"object": "created pod.kb.nl/dataset.ttl"
}
```
### Eventlog
The eventlog is a mandatory log stored in each Pod or Service Hub (eg. Registry) that participates in the network. Lifecycle events of datasets (and other artefacts) are stored there.
Example:
pod.kb.nl/eventlog
```
@prefix lode: .
@prefix time: .
_:1 a lode:Event;
lode:atTime [
a time:Instant;
time:inXSDDateTimeStamp 2020-04-12T10:30:00+10:00 .
];
lode:involvedAgent ;
dc:description "Created pod.kb.nl/dataset.ttl".
...
```
``` log
[2020-04-12T10:30:00+10:00] Created pod.kb.nl/dataset.ttl
[2020-04-12T11:30:00+10:00] Created pod.kb.nl/dataset-desc.ttl
[2020-04-12T12:30:00+10:00] Requested registration: pod.kb.nl/dataset.ttl with registry.nde.nl
[2020-04-12T13:30:00+10:00] registry.nde.nl registered pod.kb.nl/dataset.ttl
```
### Policy
A policy is a configuration file with machine-readable business rules and is the driver for the Orchestrator component. It dictates what actions the Orchestrator should take when it is notified of an event (typically by an incoming Linked Data Notification).
## Register-function API
Read the [Register API specification](/api/api-ldn.md) for more detail on a Web _application programming interface_ (API) for NDE's Register that is aligned with the Solid protocol.
## HTTP Sequences
### Initialize a Cultural Heritage Pod
### Register an Orchestrator for a Cultural Heritage Pod
### Add a new Cultural Heritage Institution to the Registry
### Add a new Dataset to the Registry
### Update a new Cultural Heritage Institution to the Registry
